Safe Haskell	None
Language	Haskell2010

Optics.IxGetter

Contents

Formation
Introduction
Elimination
Subtyping

Description

An IxGetter is an indexed version of a Getter . See the "Indexed optics" section of the overview documentation in the Optics module of the main optics package for more details on indexed optics.

Synopsis

type IxGetter i s a = Optic' A_Getter ( WithIx i) s a
ito :: (s -> (i, a)) -> IxGetter i s a
selfIndex :: IxGetter a a a
iview :: ( Is k A_Getter , is `HasSingleIndex` i) => Optic' k is s a -> s -> (i, a)
iviews :: ( Is k A_Getter , is `HasSingleIndex` i) => Optic' k is s a -> (i -> a -> r) -> s -> r
data A_Getter :: OpticKind

Formation

type IxGetter i s a = Optic' A_Getter ( WithIx i) s a Source #

Type synonym for an indexed getter.

Introduction

ito :: (s -> (i, a)) -> IxGetter i s a Source #

Build an indexed getter from a function.

>>> iview (ito id) ('i', 'x')
('i','x')

selfIndex :: IxGetter a a a Source #

Use a value itself as its own index. This is essentially an indexed version of equality .

Elimination

iview :: ( Is k A_Getter , is `HasSingleIndex` i) => Optic' k is s a -> s -> (i, a) Source #

View the value pointed to by an indexed getter.

iviews :: ( Is k A_Getter , is `HasSingleIndex` i) => Optic' k is s a -> (i -> a -> r) -> s -> r Source #

View the function of the value pointed to by an indexed getter.

Subtyping

data A_Getter :: OpticKind Source #

Tag for a getter.

Instances

Instances details

ReversibleOptic A_Getter Source #
Instance details Defined in Optics.Re Associated Types type ReversedOptic A_Getter = (r :: Type ) Source # Methods re :: forall (is :: IxList ) s t a b. AcceptsEmptyIndices "re" is => Optic A_Getter is s t a b -> Optic ( ReversedOptic A_Getter ) is b a t s Source #
Is A_Getter A_Fold Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods implies :: forall (p :: Type -> Type -> Type -> Type ) r. ( Constraints A_Getter p => r) -> Constraints A_Fold p => r Source #
Is A_Getter An_AffineFold Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods implies :: forall (p :: Type -> Type -> Type -> Type ) r. ( Constraints A_Getter p => r) -> Constraints An_AffineFold p => r Source #
Is A_ReversedPrism A_Getter Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods implies :: forall (p :: Type -> Type -> Type -> Type ) r. ( Constraints A_ReversedPrism p => r) -> Constraints A_Getter p => r Source #
Is A_Lens A_Getter Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods implies :: forall (p :: Type -> Type -> Type -> Type ) r. ( Constraints A_Lens p => r) -> Constraints A_Getter p => r Source #
Is An_Iso A_Getter Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods implies :: forall (p :: Type -> Type -> Type -> Type ) r. ( Constraints An_Iso p => r) -> Constraints A_Getter p => r Source #
k ~ A_Fold => JoinKinds A_Fold A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Fold p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
k ~ An_AffineFold => JoinKinds An_AffineFold A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints An_AffineFold p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
k ~ A_Fold => JoinKinds A_Getter A_Fold k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints A_Fold p) => r) -> Constraints k p => r Source #
k ~ An_AffineFold => JoinKinds A_Getter An_AffineFold k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints An_AffineFold p) => r) -> Constraints k p => r Source #
k ~ A_Getter => JoinKinds A_Getter A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
k ~ A_Getter => JoinKinds A_Getter A_ReversedPrism k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints A_ReversedPrism p) => r) -> Constraints k p => r Source #
k ~ A_Fold => JoinKinds A_Getter A_Traversal k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints A_Traversal p) => r) -> Constraints k p => r Source #
k ~ An_AffineFold => JoinKinds A_Getter An_AffineTraversal k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints An_AffineTraversal p) => r) -> Constraints k p => r Source #
k ~ An_AffineFold => JoinKinds A_Getter A_Prism k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints A_Prism p) => r) -> Constraints k p => r Source #
k ~ A_Getter => JoinKinds A_Getter A_Lens k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints A_Lens p) => r) -> Constraints k p => r Source #
k ~ A_Getter => JoinKinds A_Getter An_Iso k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Getter p, Constraints An_Iso p) => r) -> Constraints k p => r Source #
k ~ A_Getter => JoinKinds A_ReversedPrism A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_ReversedPrism p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
k ~ A_Fold => JoinKinds A_Traversal A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Traversal p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
k ~ An_AffineFold => JoinKinds An_AffineTraversal A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints An_AffineTraversal p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
k ~ An_AffineFold => JoinKinds A_Prism A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Prism p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
k ~ A_Getter => JoinKinds A_Lens A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints A_Lens p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
k ~ A_Getter => JoinKinds An_Iso A_Getter k Source #
Instance details Defined in Optics.Internal.Optic.Subtyping Methods joinKinds :: forall (p :: Type -> Type -> Type -> Type ) r. (( Constraints An_Iso p, Constraints A_Getter p) => r) -> Constraints k p => r Source #
(s ~ t, a ~ b) => ToReadOnly A_Getter s t a b Source #
Instance details Defined in Optics.ReadOnly Associated Types type ReadOnlyOptic A_Getter Source # Methods getting :: forall (is :: IxList ). Optic A_Getter is s t a b -> Optic' ( ReadOnlyOptic A_Getter ) is s a Source #
(s ~ t, a ~ b) => IxOptic A_Getter s t a b Source #
Instance details Defined in Optics.Indexed.Core Methods noIx :: forall (is :: IxList ). NonEmptyIndices is => Optic A_Getter is s t a b -> Optic A_Getter NoIx s t a b Source #
( Functor f, f ~ g, s ~ t, a ~ b) => MappingOptic A_Getter f g s t a b Source #	`>>>` `[('a', True), ('b', False)] ^. _1 %& mapping`"ab" `>>>` `let v = [[ (('a', True), "foo"), (('b', False), "bar")], [ (('c', True), "xyz") ] ]``>>>` `v ^. _1 % _2 %& mapping %& mapping`[[True,False],[True]]
Instance details Defined in Optics.Mapping Associated Types type MappedOptic A_Getter Source # Methods mapping :: forall (is :: IxList ). AcceptsEmptyIndices "mapping" is => Optic A_Getter is s t a b -> Optic ( MappedOptic A_Getter ) is (f s) (g t) (f a) (g b) Source #
type ReversedOptic A_Getter Source #
Instance details Defined in Optics.Re type ReversedOptic A_Getter = A_Review
type ReadOnlyOptic A_Getter Source #
Instance details Defined in Optics.ReadOnly type ReadOnlyOptic A_Getter = A_Getter
type MappedOptic A_Getter Source #
Instance details Defined in Optics.Mapping type MappedOptic A_Getter = A_Getter