ProAbstract.Optics

Content

content :: HasContent x x' => Lens x x' (Content x) (Content x')

contents :: HasContents x x' => Lens x x' (Seq (Contents x)) (Seq (Contents x'))

Tags

tag :: HasTag x => Optic' (TagOpticKind x) NoIx x (Tag (Annotation x))

name :: (HasTag x, JoinKinds (TagOpticKind x) A_Lens k) => Optic' k NoIx x Text

allTags :: HasManyTags x => Traversal' x (Tag (Annotation x))

allInlineTags :: HasManyTags x => Traversal' x (Tag (Annotation x))

allBlockTags :: HasManyBlockTags x => Traversal' x (Tag (Annotation x))

Annotation

annotation :: HasAnnotation x x' => Lens x x' (Annotation x) (Annotation x')

allAnnotations :: HasManyAnnotations x x' => Traversal x x' (Annotation x) (Annotation x')

Metadata

metadata :: HasMetadata x => Optic' (MetadataOpticKind x) NoIx x Metadata

atSetting :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Text -> Optic' k NoIx m (Maybe Text)

Select a setting from an item attached to metadata. Returns Nothing if no value is set.

hasProperty :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Text -> Optic' k NoIx m Bool

Check if a property is attached to an item with metadata. Using this optic as a setter will add a property if set to True and remove the property when set to False.

properties :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Optic' k NoIx m (Set Text)

Fetch all properties from items which contain metadata.

settings :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Optic' k NoIx m (Map Text Text)

Fetch all settings defined on items which contain metadata.

allMetadata :: HasManyMetadata x => Traversal' x Metadata

metaList :: (HasMetadata m, Is (MetadataOpticKind m) An_AffineFold) => Getter m [MetaItem]

metaMap :: (HasMetadata m, JoinKinds (MetadataOpticKind m) An_Iso k) => Optic' k NoIx m (Map Text MetaValue)

Structure

fork :: CanFork x => Prism' x (Fork x)

plain :: CanBePlain x => Prism' x (Plain x)

tagged :: IsTaggedOrBare a => Prism' a (TaggedType a)

bare :: IsTaggedOrBare a => Prism' a (BareType a)

taggedOrBare :: IsTaggedOrBare a => Iso' a (TaggedOrBare a)

allParagraphs :: HasManyParagraphs x => Traversal' x (Paragraph (Annotation x))

allPlainBlocks :: HasManyPlainBlocks x => Traversal' x (TaggedPlainBlock (Annotation x))

allPlainInlines :: HasManyPlainInlines x => Traversal' x (Fragment (Annotation x))

Taglessness

tagless :: CanBeTagless a => KindOfText txt -> AffineFold a txt

taglessContent :: CanHaveTaglessContent a => KindOfText t -> AffineFold a t

data KindOfText txt where

Constructors

TextLine :: KindOfText Text

TextStanza :: KindOfText (Seq Text)

TextParagraphs :: KindOfText (Seq (Seq Text))