Prosidy.Optics.Types

Classy optics

Items with Metadata

class HasMetadata t where

A classy optic for focusing on items with Metadata, including Tags, Regions, and Documents.

Methods

metadata :: Lens' t Metadata

Instances

HasMetadata Metadata

Defined in Prosidy.Optics.Types

Methods

metadata :: Lens' Metadata Metadata

HasMetadata Document

Defined in Prosidy.Optics.Types

Methods

metadata :: Lens' Document Metadata

HasMetadata (Tag a)

Defined in Prosidy.Optics.Types

Methods

metadata :: Lens' (Tag a) Metadata

HasMetadata (Region a)

Defined in Prosidy.Optics.Types

Methods

metadata :: Lens' (Region a) Metadata

properties :: HasMetadata m => Lens' m (Set Key)

Fetch all properties from items which contain metadata.

settings :: HasMetadata m => Lens' m (Assoc Key Text)

Fetch all settings defined on items which contain metadata.

hasProperty :: HasMetadata m => Key -> Lens' 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.

atSetting :: HasMetadata m => Key -> Lens' m (Maybe Text)

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

Items wrapping content

class HasContent t where

An optic for selecting children of an item in a recursive structure.

Associated Types

type Content t

The type of all of the children collectively. For instance, type Content Document = Series Block, as Document has zero or more contained Blocks.

Methods

content :: Lens' t (Content t)

Instances

HasContent Paragraph

Defined in Prosidy.Optics.Types

Associated Types

type Content Paragraph

Methods

content :: Lens' Paragraph (Content Paragraph)

HasContent Document

Defined in Prosidy.Optics.Types

Associated Types

type Content Document

Methods

content :: Lens' Document (Content Document)

HasContent (Tag a)

Defined in Prosidy.Optics.Types

Associated Types

type Content (Tag a)

Methods

content :: Lens' (Tag a) (Content (Tag a))

HasContent (Region a)

Defined in Prosidy.Optics.Types

Associated Types

type Content (Region a)

Methods

content :: Lens' (Region a) (Content (Region a))

Accessors for fields not otherwise covered

tag :: Lens' (Tag a) Key

Focus on the name of a Tag.

fragment :: Lens' Fragment Text

Get the contents of a Fragment.

Conversion between Tags and Regions.

tagged :: Key -> Prism' (Tag a) (Region a)

Focus on the inner Region of Tags with a name. This can be used to filter Tags to a specific subset for manipulation.

Prisms on Block contexts

_BlockTag :: Prism' Block BlockTag

Focus only on block tags.

_BlockLiteral :: Prism' Block LiteralTag

Focus only on literal tags.

_BlockParagraph :: Prism' Block Paragraph

Focus only on paragraphs'

Prisms on Inline contexts

_InlineTag :: Prism' Inline InlineTag

Focus only on inline tags.

_Text :: Prism' Inline Fragment

Focus only on text nodes.

_Break :: Prism' Inline ()

Focus only on breaks.

Optics on common types

key :: Prism' Text Key

A Prism from Text into a valid Key.

_Assoc :: Iso (Assoc k v) (Assoc k' v') (HashMap k v) (HashMap k' v')

An isomorphism between Prosidy's Assoc wrapper and HashMap.

_NonEmpty :: Prism' (Series a) (SeriesNE a)

A prism between possibly-empty and non-empty containers.

_Series :: Iso (Series a) (Series b) (Seq a) (Seq b)

An isomorpism between Prosidy's Series wrapper and Seq.

_SeriesNE :: Prism' (Seq a) (SeriesNE a)

A prism from a non-empty Seq into a SeriesNE.

_Set :: Iso (Set a) (Set b) (HashSet a) (HashSet b)

An isomorphism between Prosidy's Set wrapper and HashSet.