Z.Data.YAML.FFI

LibYAML bindings, which provide streaming YAML read & write.

The event stream

data MarkedEvent

Constructors

MarkedEvent

Fields

• markedEvent :: !Event
• startMark :: !Mark
• endMark :: !Mark

Instances

Eq MarkedEvent

Defined in Z.Data.YAML.FFI

Methods

(==) :: MarkedEvent -> MarkedEvent -> Bool

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

Ord MarkedEvent

Defined in Z.Data.YAML.FFI

Methods

compare :: MarkedEvent -> MarkedEvent -> Ordering

(<) :: MarkedEvent -> MarkedEvent -> Bool

(<=) :: MarkedEvent -> MarkedEvent -> Bool

(>) :: MarkedEvent -> MarkedEvent -> Bool

(>=) :: MarkedEvent -> MarkedEvent -> Bool

max :: MarkedEvent -> MarkedEvent -> MarkedEvent

min :: MarkedEvent -> MarkedEvent -> MarkedEvent

Show MarkedEvent

Defined in Z.Data.YAML.FFI

Methods

showsPrec :: Int -> MarkedEvent -> ShowS

show :: MarkedEvent -> String

showList :: [MarkedEvent] -> ShowS

Generic MarkedEvent

Defined in Z.Data.YAML.FFI

Associated Types

type Rep MarkedEvent :: Type -> Type

Methods

from :: MarkedEvent -> Rep MarkedEvent x

to :: Rep MarkedEvent x -> MarkedEvent

JSON MarkedEvent

Defined in Z.Data.YAML.FFI

Methods

fromValue :: Value -> Converter MarkedEvent

toValue :: MarkedEvent -> Value

encodeJSON :: MarkedEvent -> Builder ()

Print MarkedEvent

Defined in Z.Data.YAML.FFI

Methods

toUTF8BuilderP :: Int -> MarkedEvent -> Builder ()

type Rep MarkedEvent

Defined in Z.Data.YAML.FFI

type Rep MarkedEvent = D1 ('MetaData "MarkedEvent" "Z.Data.YAML.FFI" "Z-YAML-0.3.4.0-BBUS0LP1aRfzo2wF1iO21" 'False) (C1 ('MetaCons "MarkedEvent" 'PrefixI 'True) (S1 ('MetaSel ('Just "markedEvent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Event) :*: (S1 ('MetaSel ('Just "startMark") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Mark) :*: S1 ('MetaSel ('Just "endMark") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Mark))))

data Mark

The pointer position

Constructors

Mark

Fields

• yamlIndex :: !Int
• yamlLine :: !Int
• yamlColumn :: !Int

Instances

Eq Mark

Defined in Z.Data.YAML.FFI

Methods

(==) :: Mark -> Mark -> Bool

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

Ord Mark

Defined in Z.Data.YAML.FFI

Methods

compare :: Mark -> Mark -> Ordering

(<) :: Mark -> Mark -> Bool

(<=) :: Mark -> Mark -> Bool

(>) :: Mark -> Mark -> Bool

(>=) :: Mark -> Mark -> Bool

max :: Mark -> Mark -> Mark

min :: Mark -> Mark -> Mark

Show Mark

Defined in Z.Data.YAML.FFI

Methods

showsPrec :: Int -> Mark -> ShowS

show :: Mark -> String

showList :: [Mark] -> ShowS

Generic Mark

Defined in Z.Data.YAML.FFI

Associated Types

type Rep Mark :: Type -> Type

Methods

from :: Mark -> Rep Mark x

to :: Rep Mark x -> Mark

JSON Mark

Defined in Z.Data.YAML.FFI

Methods

fromValue :: Value -> Converter Mark

toValue :: Mark -> Value

encodeJSON :: Mark -> Builder ()

Print Mark

Defined in Z.Data.YAML.FFI

Methods

toUTF8BuilderP :: Int -> Mark -> Builder ()

type Rep Mark

Defined in Z.Data.YAML.FFI

type Rep Mark = D1 ('MetaData "Mark" "Z.Data.YAML.FFI" "Z-YAML-0.3.4.0-BBUS0LP1aRfzo2wF1iO21" 'False) (C1 ('MetaCons "Mark" 'PrefixI 'True) (S1 ('MetaSel ('Just "yamlIndex") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "yamlLine") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "yamlColumn") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int))))

data Event

Constructors

EventStreamStart

EventStreamEnd

EventDocumentStart

EventDocumentEnd

EventAlias !Anchor

EventScalar !Anchor !Text !Tag !ScalarStyle

EventSequenceStart !Anchor !Tag !SequenceStyle

EventSequenceEnd

EventMappingStart !Anchor !Tag !MappingStyle

EventMappingEnd

Instances

Eq Event

Defined in Z.Data.YAML.FFI

Methods

(==) :: Event -> Event -> Bool

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

Ord Event

Defined in Z.Data.YAML.FFI

Methods

compare :: Event -> Event -> Ordering

(<) :: Event -> Event -> Bool

(<=) :: Event -> Event -> Bool

(>) :: Event -> Event -> Bool

(>=) :: Event -> Event -> Bool

max :: Event -> Event -> Event

min :: Event -> Event -> Event

Show Event

Defined in Z.Data.YAML.FFI

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

Generic Event

Defined in Z.Data.YAML.FFI

Associated Types

type Rep Event :: Type -> Type

Methods

from :: Event -> Rep Event x

to :: Rep Event x -> Event

JSON Event

Defined in Z.Data.YAML.FFI

Methods

fromValue :: Value -> Converter Event

toValue :: Event -> Value

encodeJSON :: Event -> Builder ()

Print Event

Defined in Z.Data.YAML.FFI

Methods

toUTF8BuilderP :: Int -> Event -> Builder ()

type Rep Event

Defined in Z.Data.YAML.FFI

type Rep Event = D1 ('MetaData "Event" "Z.Data.YAML.FFI" "Z-YAML-0.3.4.0-BBUS0LP1aRfzo2wF1iO21" 'False) (((C1 ('MetaCons "EventStreamStart" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EventStreamEnd" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "EventDocumentStart" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "EventDocumentEnd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EventAlias" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Anchor))))) :+: ((C1 ('MetaCons "EventScalar" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Anchor) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Tag) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ScalarStyle))) :+: C1 ('MetaCons "EventSequenceStart" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Anchor) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Tag) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SequenceStyle)))) :+: (C1 ('MetaCons "EventSequenceEnd" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "EventMappingStart" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Anchor) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Tag) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MappingStyle))) :+: C1 ('MetaCons "EventMappingEnd" 'PrefixI 'False) (U1 :: Type -> Type)))))

data Tag

Constructors

StrTag

FloatTag

NullTag

BoolTag

SetTag

IntTag

SeqTag

MapTag

UriTag Text

NoTag

Instances

Eq Tag

Defined in Z.Data.YAML.FFI

Methods

(==) :: Tag -> Tag -> Bool

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

Ord Tag

Defined in Z.Data.YAML.FFI

Methods

compare :: Tag -> Tag -> Ordering

(<) :: Tag -> Tag -> Bool

(<=) :: Tag -> Tag -> Bool

(>) :: Tag -> Tag -> Bool

(>=) :: Tag -> Tag -> Bool

max :: Tag -> Tag -> Tag

min :: Tag -> Tag -> Tag

Show Tag

Defined in Z.Data.YAML.FFI

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

Generic Tag

Defined in Z.Data.YAML.FFI

Associated Types

type Rep Tag :: Type -> Type

Methods

from :: Tag -> Rep Tag x

to :: Rep Tag x -> Tag

JSON Tag

Defined in Z.Data.YAML.FFI

Methods

fromValue :: Value -> Converter Tag

toValue :: Tag -> Value

encodeJSON :: Tag -> Builder ()

Print Tag

Defined in Z.Data.YAML.FFI

Methods

toUTF8BuilderP :: Int -> Tag -> Builder ()

type Rep Tag

Defined in Z.Data.YAML.FFI

type Rep Tag = D1 ('MetaData "Tag" "Z.Data.YAML.FFI" "Z-YAML-0.3.4.0-BBUS0LP1aRfzo2wF1iO21" 'False) (((C1 ('MetaCons "StrTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FloatTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NullTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "BoolTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SetTag" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "IntTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SeqTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MapTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UriTag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "NoTag" 'PrefixI 'False) (U1 :: Type -> Type)))))

type Anchor = Text

Decoding

initParser :: Bytes -> Resource (IO (Maybe MarkedEvent))

Create a source that yields marked events from a piece of YAML bytes.

initFileParser :: HasCallStack => CBytes -> Resource (IO (Maybe MarkedEvent))

Create a source that yields marked events from a piece of YAML bytes.

Encoding

data YAMLFormatOpts

Contains options relating to the formatting (indendation, width) of the YAML output.

Constructors

YAMLFormatOpts

Fields

• yamlFormatCanonical :: Bool

  use canonical style, default False

• yamlFormatIndent :: Int

  default 4

• yamlFormatWidth :: Int

  default 80

• yamlFormatRenderTags :: Event -> TagRender

initEmitter :: YAMLFormatOpts -> Resource (Ptr EmitterStruct, Event -> IO ())

Make a new YAML event sink, whose result can be fetched via getEmitterResult.

initFileEmitter :: HasCallStack => YAMLFormatOpts -> CBytes -> Resource (Event -> IO ())

Make a new YAML event sink, whose result are written to a file.

Note the file will be opened in O_APPEND .|. O_CREAT .|. O_WRONLY mode, bytes will be written after the end of the original file if there'are old bytes.

getEmitterResult :: Ptr EmitterStruct -> IO Text

Fetch YAML emitter's building buffer.

defaultYAMLFormatOpts :: YAMLFormatOpts

renderScalarTags :: Event -> TagRender

A value for yamlFormatRenderTags that renders no collection tags but all scalar tags (unless suppressed with styles 'NoTag or PlainNoTag).

renderAllTags :: Event -> TagRender

A value for yamlFormatRenderTags that renders all tags (except NoTag tag and PlainNoTag style).

renderNoTags :: Event -> TagRender

A value for yamlFormatRenderTags that renders no tags.

renderUriTags :: Event -> TagRender

Constants

type ScalarStyle = CInt

Style for scalars - e.g. quoted / folded

pattern Any :: ScalarStyle

pattern Plain :: ScalarStyle

pattern SingleQuoted :: ScalarStyle

pattern DoubleQuoted :: ScalarStyle

pattern Literal :: ScalarStyle

pattern Folded :: ScalarStyle

pattern PlainNoTag :: ScalarStyle

type SequenceStyle = CInt

Style for sequences - e.g. block or flow

pattern AnySequence :: SequenceStyle

pattern BlockSequence :: SequenceStyle

pattern FlowSequence :: SequenceStyle

type MappingStyle = CInt

Style for mappings - e.g. block or flow

pattern AnyMapping :: MappingStyle

pattern BlockMapping :: MappingStyle

pattern FlowMapping :: MappingStyle

type TagRender = CInt

Whether a tag should be rendered explicitly in the output or left implicit.

pattern Explicit :: TagRender

pattern Implicit :: TagRender

Exception type

data YAMLError

Constructors

ParseEventException CBytes CBytes Mark

problem, context, mark

ParseAliasEventWithEmptyAnchor Mark Mark

ParseYAMLError YAMLParseError

custom parse error

EmitEventException Event CInt

EmitAliasEventWithEmptyAnchor

OtherYAMLError Text

Instances

Eq YAMLError

Defined in Z.Data.YAML.FFI

Methods

(==) :: YAMLError -> YAMLError -> Bool

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

Show YAMLError

Defined in Z.Data.YAML.FFI

Methods

showsPrec :: Int -> YAMLError -> ShowS

show :: YAMLError -> String

showList :: [YAMLError] -> ShowS

Generic YAMLError

Defined in Z.Data.YAML.FFI

Associated Types

type Rep YAMLError :: Type -> Type

Methods

from :: YAMLError -> Rep YAMLError x

to :: Rep YAMLError x -> YAMLError

Print YAMLError

Defined in Z.Data.YAML.FFI

Methods

toUTF8BuilderP :: Int -> YAMLError -> Builder ()

Exception YAMLError

Defined in Z.Data.YAML.FFI

Methods

toException :: YAMLError -> SomeException

fromException :: SomeException -> Maybe YAMLError

displayException :: YAMLError -> String

type Rep YAMLError

Defined in Z.Data.YAML.FFI

type Rep YAMLError = D1 ('MetaData "YAMLError" "Z.Data.YAML.FFI" "Z-YAML-0.3.4.0-BBUS0LP1aRfzo2wF1iO21" 'False) ((C1 ('MetaCons "ParseEventException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mark))) :+: (C1 ('MetaCons "ParseAliasEventWithEmptyAnchor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mark) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mark)) :+: C1 ('MetaCons "ParseYAMLError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 YAMLParseError)))) :+: (C1 ('MetaCons "EmitEventException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Event) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt)) :+: (C1 ('MetaCons "EmitAliasEventWithEmptyAnchor" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OtherYAMLError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

data YAMLParseError

Constructors

UnknownAlias MarkedEvent

UnexpectedEvent MarkedEvent

NonStringKey MarkedEvent

NonStringKeyAlias MarkedEvent

UnexpectedEventEnd

Instances

Eq YAMLParseError

Defined in Z.Data.YAML.FFI

Methods

(==) :: YAMLParseError -> YAMLParseError -> Bool

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

Show YAMLParseError

Defined in Z.Data.YAML.FFI

Methods

showsPrec :: Int -> YAMLParseError -> ShowS

show :: YAMLParseError -> String

showList :: [YAMLParseError] -> ShowS

Generic YAMLParseError

Defined in Z.Data.YAML.FFI

Associated Types

type Rep YAMLParseError :: Type -> Type

Methods

from :: YAMLParseError -> Rep YAMLParseError x

to :: Rep YAMLParseError x -> YAMLParseError

Print YAMLParseError

Defined in Z.Data.YAML.FFI

Methods

toUTF8BuilderP :: Int -> YAMLParseError -> Builder ()

Exception YAMLParseError

Defined in Z.Data.YAML.FFI

Methods

toException :: YAMLParseError -> SomeException

fromException :: SomeException -> Maybe YAMLParseError

displayException :: YAMLParseError -> String

type Rep YAMLParseError

Defined in Z.Data.YAML.FFI

type Rep YAMLParseError = D1 ('MetaData "YAMLParseError" "Z.Data.YAML.FFI" "Z-YAML-0.3.4.0-BBUS0LP1aRfzo2wF1iO21" 'False) ((C1 ('MetaCons "UnknownAlias" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkedEvent)) :+: C1 ('MetaCons "UnexpectedEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkedEvent))) :+: (C1 ('MetaCons "NonStringKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkedEvent)) :+: (C1 ('MetaCons "NonStringKeyAlias" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkedEvent)) :+: C1 ('MetaCons "UnexpectedEventEnd" 'PrefixI 'False) (U1 :: Type -> Type))))

throwYAMLError :: YAMLParseError -> IO a

Throw custom YAML error.