Copyright	©2020 James Alexander Feldman-Crough
License	MPL-2.0
Maintainer	alex@fldcr.com
Safe Haskell	Safe
Language	Haskell2010

Prosidy.Optics.Types

Contents

Classy optics
- Items with Metadata
- Items wrapping content
Accessors for fields not otherwise covered
Conversion between Tags and Regions.
Prisms on Block contexts
Prisms on Inline contexts
Optics on common types

Description

Synopsis

class HasMetadata t where
- metadata :: Lens' t Metadata
properties :: HasMetadata m => Lens' m (Set Key)
settings :: HasMetadata m => Lens' m (Assoc Key Text)
hasProperty :: HasMetadata m => Key -> Lens' m Bool
atSetting :: HasMetadata m => Key -> Lens' m (Maybe Text)
class HasContent t where
- type Content t
- content :: Lens' t (Content t)
tag :: Lens' (Tag a) Key
fragment :: Lens' Fragment Text
tagged :: Key -> Prism' (Tag a) (Region a)
_BlockTag :: Prism' Block BlockTag
_BlockLiteral :: Prism' Block LiteralTag
_BlockParagraph :: Prism' Block Paragraph
_InlineTag :: Prism' Inline InlineTag
_Text :: Prism' Inline Fragment
_Break :: Prism' Inline ()
key :: Prism' Text Key
_Assoc :: Iso (Assoc k v) (Assoc k' v') (HashMap k v) (HashMap k' v')
_NonEmpty :: Prism' (Series a) (SeriesNE a)
_Series :: Iso (Series a) (Series b) (Seq a) (Seq b)
_SeriesNE :: Prism' (Seq a) (SeriesNE a)
_Set :: Iso (Set a) (Set b) (HashSet a) (HashSet b)

Classy optics

Items with `Metadata`

class HasMetadata t where Source #

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

Methods

metadata :: Lens' t Metadata Source #

Instances

Instances details

HasMetadata Metadata Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' Metadata Metadata Source #
HasMetadata Document Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' Document Metadata Source #
HasMetadata (Tag a) Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' (Tag a) Metadata Source #
HasMetadata (Region a) Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' (Region a) Metadata Source #

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

Fetch all properties from items which contain metadata.

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

Fetch all settings defined on items which contain metadata.

hasProperty :: HasMetadata m => Key -> Lens' m Bool Source #

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) Source #

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

Items wrapping content

class HasContent t where Source #

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

Associated Types

type Content t Source #

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) Source #

Instances

Instances details

HasContent Paragraph Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content Paragraph Source # Methods content :: Lens' Paragraph (Content Paragraph) Source #
HasContent Document Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content Document Source # Methods content :: Lens' Document (Content Document) Source #
HasContent (Tag a) Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content (Tag a) Source # Methods content :: Lens' (Tag a) (Content (Tag a)) Source #
HasContent (Region a) Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content (Region a) Source # Methods content :: Lens' (Region a) (Content (Region a)) Source #