ProAbstract.Metadata

Documentation

data Metadata

A set of properties and settings, associated with a document or tag.

The namespaces of properties and settings are distinct; a property can share a name with a setting without conflict.

Constructors

Metadata

Fields

• metadataProperties :: Set Text

  properties

• metadataSettings :: Map Text Text

  settings

Instances

Eq Metadata

Defined in ProAbstract.Metadata.MetadataType

Methods

(==) :: Metadata -> Metadata -> Bool

(/=) :: Metadata -> Metadata -> Bool

Show Metadata

Defined in ProAbstract.Metadata.MetadataType

Methods

showsPrec :: Int -> Metadata -> ShowS

show :: Metadata -> String

showList :: [Metadata] -> ShowS

Generic Metadata

Defined in ProAbstract.Metadata.MetadataType

Associated Types

type Rep Metadata :: Type -> Type

Methods

from :: Metadata -> Rep Metadata x

to :: Rep Metadata x -> Metadata

Semigroup Metadata

Defined in ProAbstract.Metadata.MetadataType

Methods

(<>) :: Metadata -> Metadata -> Metadata

sconcat :: NonEmpty Metadata -> Metadata

stimes :: Integral b => b -> Metadata -> Metadata

Monoid Metadata

Defined in ProAbstract.Metadata.MetadataType

Methods

mempty :: Metadata

mappend :: Metadata -> Metadata -> Metadata

mconcat :: [Metadata] -> Metadata

NFData Metadata

Defined in ProAbstract.Metadata.MetadataType

Methods

rnf :: Metadata -> ()

Hashable Metadata

Defined in ProAbstract.Metadata.MetadataType

Methods

hashWithSalt :: Int -> Metadata -> Int

hash :: Metadata -> Int

HasMetadata Metadata

Defined in ProAbstract.Metadata.HasMetadata

Associated Types

type MetadataOpticKind Metadata

Methods

metadata :: Optic' (MetadataOpticKind Metadata) NoIx Metadata Metadata

type Rep Metadata

Defined in ProAbstract.Metadata.MetadataType

type Rep Metadata = D1 ('MetaData "Metadata" "ProAbstract.Metadata.MetadataType" "pro-abstract-0.1.0.0-fAo99Omz3u7l2SA6DiDR2" 'False) (C1 ('MetaCons "Metadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "metadataProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Text)) :*: S1 ('MetaSel ('Just "metadataSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Text))))

type MetadataOpticKind Metadata

Defined in ProAbstract.Metadata.HasMetadata

type MetadataOpticKind Metadata = An_Iso

class HasMetadata x where

Associated Types

type MetadataOpticKind x

Methods

metadata :: Optic' (MetadataOpticKind x) NoIx x Metadata

Instances

HasMetadata Metadata

Defined in ProAbstract.Metadata.HasMetadata

Associated Types

type MetadataOpticKind Metadata

Methods

metadata :: Optic' (MetadataOpticKind Metadata) NoIx Metadata Metadata

HasMetadata (Tag ann)

Defined in ProAbstract.Tag.TagType

Associated Types

type MetadataOpticKind (Tag ann)

Methods

metadata :: Optic' (MetadataOpticKind (Tag ann)) NoIx (Tag ann) Metadata

HasMetadata (Tagged (PlainBlock ann))

Defined in ProAbstract.Structure.PlainBlock

Associated Types

type MetadataOpticKind (Tagged (PlainBlock ann))

Methods

metadata :: Optic' (MetadataOpticKind (Tagged (PlainBlock ann))) NoIx (Tagged (PlainBlock ann)) Metadata

HasMetadata (Tagged (Lines ann))

Defined in ProAbstract.Structure.Inline

Associated Types

type MetadataOpticKind (Tagged (Lines ann))

Methods

metadata :: Optic' (MetadataOpticKind (Tagged (Lines ann))) NoIx (Tagged (Lines ann)) Metadata

HasMetadata (Tagged (Blocks ann))

Defined in ProAbstract.Structure.Block

Associated Types

type MetadataOpticKind (Tagged (Blocks ann))

Methods

metadata :: Optic' (MetadataOpticKind (Tagged (Blocks ann))) NoIx (Tagged (Blocks ann)) Metadata

HasMetadata (Inline ann)

Defined in ProAbstract.Structure.Inline

Associated Types

type MetadataOpticKind (Inline ann)

Methods

metadata :: Optic' (MetadataOpticKind (Inline ann)) NoIx (Inline ann) Metadata

HasMetadata (Block ann)

Defined in ProAbstract.Structure.Block

Associated Types

type MetadataOpticKind (Block ann)

Methods

metadata :: Optic' (MetadataOpticKind (Block ann)) NoIx (Block ann) Metadata

HasMetadata (Document ann)

Defined in ProAbstract.Structure.Document

Associated Types

type MetadataOpticKind (Document ann)

Methods

metadata :: Optic' (MetadataOpticKind (Document ann)) NoIx (Document ann) Metadata

HasMetadata (BlockTag ann)

Defined in ProAbstract.Structure.BlockTag

Associated Types

type MetadataOpticKind (BlockTag ann)

Methods

metadata :: Optic' (MetadataOpticKind (BlockTag ann)) NoIx (BlockTag ann) Metadata

class HasManyMetadata x where

Methods

allMetadata :: Traversal' x Metadata

Instances

HasManyMetadata (Tagged (Lines ann))

Defined in ProAbstract.Structure.Inline

Methods

allMetadata :: Traversal' (Tagged (Lines ann)) Metadata

HasManyMetadata (Tagged (Blocks ann))

Defined in ProAbstract.Structure.Block

Methods

allMetadata :: Traversal' (Tagged (Blocks ann)) Metadata

HasManyMetadata (Lines ann)

Defined in ProAbstract.Structure.Inline

Methods

allMetadata :: Traversal' (Lines ann) Metadata

HasManyMetadata (Line ann)

Defined in ProAbstract.Structure.Inline

Methods

allMetadata :: Traversal' (Line ann) Metadata

HasManyMetadata (Inline ann)

Defined in ProAbstract.Structure.Inline

Methods

allMetadata :: Traversal' (Inline ann) Metadata

HasManyMetadata (Paragraph ann)

Defined in ProAbstract.Structure.Paragraph

Methods

allMetadata :: Traversal' (Paragraph ann) Metadata

HasManyMetadata (Blocks ann)

Defined in ProAbstract.Structure.Block

Methods

allMetadata :: Traversal' (Blocks ann) Metadata

HasManyMetadata (Block ann)

Defined in ProAbstract.Structure.Block

Methods

allMetadata :: Traversal' (Block ann) Metadata

HasManyMetadata (Document ann)

Defined in ProAbstract.Structure.Document

Methods

allMetadata :: Traversal' (Document ann) Metadata

HasManyMetadata (BlockTag ann)

Defined in ProAbstract.Structure.BlockTag

Methods

allMetadata :: Traversal' (BlockTag ann) Metadata

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.

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.

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.