Safe Haskell	None
Language	GHC2021

Ondim.Advanced

Description

This module is for advanced users. Generally speaking, you should only use this module if you want to define new targets (formats) or customize existing ones.

Documentation

class (Typeable t, Expansible t) => OndimNode t where Source #

Minimal complete definition

Nothing

Methods

identify :: t -> Maybe Text Source #

Returns the name of the node as defined by the OndimNode instance.

attributes :: t -> Ondim s [Attribute] Source #

Returns a list of attributes of the node as defined by the OndimNode instance.

children :: t -> [t] Source #

Returns the children of the node as defined by the OndimNode instance.

castFrom :: OndimNode a => Maybe (a -> [t]) Source #

renderNode :: Maybe (t -> LByteString) Source #

Converts the node to a LByteString as defined by the OndimNode instance.

nodeAsText :: Maybe (t -> Text) Source #

Instances

Instances details

OndimNode Attribute Source #
Instance details Defined in Ondim.Internal.Class Methods identify :: Attribute -> Maybe Text Source # attributes :: Attribute -> Ondim s [Attribute] Source # children :: Attribute -> [Attribute] Source # castFrom :: OndimNode a => Maybe (a -> [Attribute]) Source # renderNode :: Maybe (Attribute -> LByteString) Source # nodeAsText :: Maybe (Attribute -> Text) Source #
OndimNode LByteString Source #
Instance details Defined in Ondim.Internal.Class Methods identify :: LByteString -> Maybe Text Source # attributes :: LByteString -> Ondim s [Attribute] Source # children :: LByteString -> [LByteString] Source # castFrom :: OndimNode a => Maybe (a -> [LByteString]) Source # renderNode :: Maybe (LByteString -> LByteString) Source # nodeAsText :: Maybe (LByteString -> Text) Source #
OndimNode Text Source #
Instance details Defined in Ondim.Internal.Class Methods identify :: Text -> Maybe Text Source # attributes :: Text -> Ondim s [Attribute] Source # children :: Text -> [Text] Source # castFrom :: OndimNode a => Maybe (a -> [Text]) Source # renderNode :: Maybe (Text -> LByteString) Source # nodeAsText :: Maybe (Text -> Text) Source #
(OndimNode a, Expansible (t a), Foldable t, Typeable t) => OndimNode (t a) Source #
Instance details Defined in Ondim.Internal.Class Methods identify :: t a -> Maybe Text Source # attributes :: t a -> Ondim s [Attribute] Source # children :: t a -> [t a] Source # castFrom :: OndimNode a0 => Maybe (a0 -> [t a]) Source # renderNode :: Maybe (t a -> LByteString) Source # nodeAsText :: Maybe (t a -> Text) Source #

class Expansible t where Source #

Methods

expandSubs :: t -> Ondim s t Source #

Expand only the substructures of a node.

Instances

Instances details

Expansible Attribute Source #
Instance details Defined in Ondim.Internal.Class Methods expandSubs :: Attribute -> Ondim s Attribute Source #
Expansible LByteString Source #
Instance details Defined in Ondim.Internal.Class Methods expandSubs :: LByteString -> Ondim s LByteString Source #
Expansible Text Source #
Instance details Defined in Ondim.Internal.Class Methods expandSubs :: Text -> Ondim s Text Source #
OndimNode t => Expansible (Seq t) Source #
Instance details Defined in Ondim.Internal.Core Methods expandSubs :: Seq t -> Ondim s (Seq t) Source #
OndimNode t => Expansible [t] Source #
Instance details Defined in Ondim.Internal.Core Methods expandSubs :: [t] -> Ondim s [t] Source #