| License | AGPL-3 |
|---|---|
| Maintainer | stu235271@mail.uni-kiel.de stu236925@mail.uni-kiel.de |
| Safe Haskell | None |
| Language | Haskell2010 |
Docs.MetaTree
Description
This module contains the definition of a tree with additional meta data such as labels, titles and allowed edit actions.
Synopsis
- data MetaNode a = MetaNode {
- header :: NodeHeader
- children :: [Meta a]
- data MetaTree a
- data Meta a = Meta {}
- data TocEntry = TocEntry {}
- data TreeWithMetaData a = TreeWithMetaData {
- root :: Meta a
- metaMap :: Map FullTypeName ProperTypeMeta
- data TreeRevisionWithMetaData a = TreeRevisionWithMetaData {}
Documentation
Like Docs.Tree.Node, but with ✨metadata✨.
Constructors
| MetaNode | |
Fields
| |
Instances
| Foldable MetaNode Source # | |||||
Defined in Docs.MetaTree Methods fold :: Monoid m => MetaNode m -> m # foldMap :: Monoid m => (a -> m) -> MetaNode a -> m # foldMap' :: Monoid m => (a -> m) -> MetaNode a -> m # foldr :: (a -> b -> b) -> b -> MetaNode a -> b # foldr' :: (a -> b -> b) -> b -> MetaNode a -> b # foldl :: (b -> a -> b) -> b -> MetaNode a -> b # foldl' :: (b -> a -> b) -> b -> MetaNode a -> b # foldr1 :: (a -> a -> a) -> MetaNode a -> a # foldl1 :: (a -> a -> a) -> MetaNode a -> a # elem :: Eq a => a -> MetaNode a -> Bool # maximum :: Ord a => MetaNode a -> a # minimum :: Ord a => MetaNode a -> a # | |||||
| Traversable MetaNode Source # | |||||
| Functor MetaNode Source # | |||||
| FromJSON a => FromJSON (MetaNode a) Source # | |||||
Defined in Docs.MetaTree Methods parseJSON :: Value -> Parser (MetaNode a) parseJSONList :: Value -> Parser [MetaNode a] omittedField :: Maybe (MetaNode a) | |||||
| ToJSON a => ToJSON (MetaNode a) Source # | |||||
Defined in Docs.MetaTree Methods toEncoding :: MetaNode a -> Encoding toJSONList :: [MetaNode a] -> Value toEncodingList :: [MetaNode a] -> Encoding | |||||
| Generic (MetaNode a) Source # | |||||
Defined in Docs.MetaTree Associated Types
| |||||
| ToSchema a => ToSchema (MetaNode a) Source # | |||||
Defined in Docs.MetaTree Methods declareNamedSchema :: Proxy (MetaNode a) -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep (MetaNode a) Source # | |||||
Defined in Docs.MetaTree type Rep (MetaNode a) = D1 ('MetaData "MetaNode" "Docs.MetaTree" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "MetaNode" 'PrefixI 'True) (S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NodeHeader) :*: S1 ('MetaSel ('Just "children") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Meta a]))) | |||||
Like Docs.Tree.Tree, but with ✨metadata✨.
Instances
| Foldable MetaTree Source # | |||||
Defined in Docs.MetaTree Methods fold :: Monoid m => MetaTree m -> m # foldMap :: Monoid m => (a -> m) -> MetaTree a -> m # foldMap' :: Monoid m => (a -> m) -> MetaTree a -> m # foldr :: (a -> b -> b) -> b -> MetaTree a -> b # foldr' :: (a -> b -> b) -> b -> MetaTree a -> b # foldl :: (b -> a -> b) -> b -> MetaTree a -> b # foldl' :: (b -> a -> b) -> b -> MetaTree a -> b # foldr1 :: (a -> a -> a) -> MetaTree a -> a # foldl1 :: (a -> a -> a) -> MetaTree a -> a # elem :: Eq a => a -> MetaTree a -> Bool # maximum :: Ord a => MetaTree a -> a # minimum :: Ord a => MetaTree a -> a # | |||||
| Traversable MetaTree Source # | |||||
| Functor MetaTree Source # | |||||
| FromJSON a => FromJSON (MetaTree a) Source # | |||||
Defined in Docs.MetaTree Methods parseJSON :: Value -> Parser (MetaTree a) parseJSONList :: Value -> Parser [MetaTree a] omittedField :: Maybe (MetaTree a) | |||||
| ToJSON a => ToJSON (MetaTree a) Source # | |||||
Defined in Docs.MetaTree Methods toEncoding :: MetaTree a -> Encoding toJSONList :: [MetaTree a] -> Value toEncodingList :: [MetaTree a] -> Encoding | |||||
| Generic (MetaTree a) Source # | |||||
Defined in Docs.MetaTree Associated Types
| |||||
| ToSchema a => ToSchema (MetaTree a) Source # | |||||
Defined in Docs.MetaTree Methods declareNamedSchema :: Proxy (MetaTree a) -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep (MetaTree a) Source # | |||||
Defined in Docs.MetaTree type Rep (MetaTree a) = D1 ('MetaData "MetaTree" "Docs.MetaTree" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "MetaTree" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MetaNode a))) :+: C1 ('MetaCons "MetaLeaf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a))) | |||||
Wrapper around a MetaTree, but with ✨metadata✨.
Instances
| Foldable Meta Source # | |||||
Defined in Docs.MetaTree Methods fold :: Monoid m => Meta m -> m # foldMap :: Monoid m => (a -> m) -> Meta a -> m # foldMap' :: Monoid m => (a -> m) -> Meta a -> m # foldr :: (a -> b -> b) -> b -> Meta a -> b # foldr' :: (a -> b -> b) -> b -> Meta a -> b # foldl :: (b -> a -> b) -> b -> Meta a -> b # foldl' :: (b -> a -> b) -> b -> Meta a -> b # foldr1 :: (a -> a -> a) -> Meta a -> a # foldl1 :: (a -> a -> a) -> Meta a -> a # elem :: Eq a => a -> Meta a -> Bool # maximum :: Ord a => Meta a -> a # | |||||
| Traversable Meta Source # | |||||
| Functor Meta Source # | |||||
| FromJSON a => FromJSON (Meta a) Source # | |||||
Defined in Docs.MetaTree Methods parseJSON :: Value -> Parser (Meta a) parseJSONList :: Value -> Parser [Meta a] omittedField :: Maybe (Meta a) | |||||
| ToJSON a => ToJSON (Meta a) Source # | |||||
Defined in Docs.MetaTree Methods toEncoding :: Meta a -> Encoding toJSONList :: [Meta a] -> Value toEncodingList :: [Meta a] -> Encoding | |||||
| Generic (Meta a) Source # | |||||
Defined in Docs.MetaTree Associated Types
| |||||
| ToSchema a => ToSchema (Meta a) Source # | |||||
Defined in Docs.MetaTree Methods declareNamedSchema :: Proxy (Meta a) -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep (Meta a) Source # | |||||
Defined in Docs.MetaTree type Rep (Meta a) = D1 ('MetaData "Meta" "Docs.MetaTree" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "Meta" 'PrefixI 'True) (S1 ('MetaSel ('Just "meta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TocEntry) :*: S1 ('MetaSel ('Just "tree") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MetaTree a)))) | |||||
Information on how the node should be displayed in the Table of Contents.
Constructors
| TocEntry | |
Instances
data TreeWithMetaData a Source #
Wrapper around the root of a tree, but with ✨metadata✨.
Constructors
| TreeWithMetaData | |
Fields
| |
Instances
| Functor TreeWithMetaData Source # | |||||
Defined in Docs.MetaTree Methods fmap :: (a -> b) -> TreeWithMetaData a -> TreeWithMetaData b # (<$) :: a -> TreeWithMetaData b -> TreeWithMetaData a # | |||||
| FromJSON a => FromJSON (TreeWithMetaData a) Source # | |||||
Defined in Docs.MetaTree Methods parseJSON :: Value -> Parser (TreeWithMetaData a) parseJSONList :: Value -> Parser [TreeWithMetaData a] omittedField :: Maybe (TreeWithMetaData a) | |||||
| ToJSON a => ToJSON (TreeWithMetaData a) Source # | |||||
Defined in Docs.MetaTree Methods toJSON :: TreeWithMetaData a -> Value toEncoding :: TreeWithMetaData a -> Encoding toJSONList :: [TreeWithMetaData a] -> Value toEncodingList :: [TreeWithMetaData a] -> Encoding omitField :: TreeWithMetaData a -> Bool | |||||
| Generic (TreeWithMetaData a) Source # | |||||
Defined in Docs.MetaTree Associated Types
Methods from :: TreeWithMetaData a -> Rep (TreeWithMetaData a) x # to :: Rep (TreeWithMetaData a) x -> TreeWithMetaData a # | |||||
| ToSchema a => ToSchema (TreeWithMetaData a) Source # | |||||
Defined in Docs.MetaTree Methods declareNamedSchema :: Proxy (TreeWithMetaData a) -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep (TreeWithMetaData a) Source # | |||||
Defined in Docs.MetaTree type Rep (TreeWithMetaData a) = D1 ('MetaData "TreeWithMetaData" "Docs.MetaTree" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TreeWithMetaData" 'PrefixI 'True) (S1 ('MetaSel ('Just "root") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Meta a)) :*: S1 ('MetaSel ('Just "metaMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map FullTypeName ProperTypeMeta)))) | |||||
data TreeRevisionWithMetaData a Source #
Like Docs.TreeRevision.TreeRevision, but with ✨metadata✨.
Constructors
| TreeRevisionWithMetaData | |
Fields
| |
Instances
| Functor TreeRevisionWithMetaData Source # | |||||
Defined in Docs.MetaTree Methods fmap :: (a -> b) -> TreeRevisionWithMetaData a -> TreeRevisionWithMetaData b # (<$) :: a -> TreeRevisionWithMetaData b -> TreeRevisionWithMetaData a # | |||||
| FromJSON a => FromJSON (TreeRevisionWithMetaData a) Source # | |||||
Defined in Docs.MetaTree Methods parseJSON :: Value -> Parser (TreeRevisionWithMetaData a) parseJSONList :: Value -> Parser [TreeRevisionWithMetaData a] | |||||
| ToJSON a => ToJSON (TreeRevisionWithMetaData a) Source # | |||||
Defined in Docs.MetaTree Methods toJSON :: TreeRevisionWithMetaData a -> Value toEncoding :: TreeRevisionWithMetaData a -> Encoding toJSONList :: [TreeRevisionWithMetaData a] -> Value toEncodingList :: [TreeRevisionWithMetaData a] -> Encoding omitField :: TreeRevisionWithMetaData a -> Bool | |||||
| Generic (TreeRevisionWithMetaData a) Source # | |||||
Defined in Docs.MetaTree Associated Types
Methods from :: TreeRevisionWithMetaData a -> Rep (TreeRevisionWithMetaData a) x # to :: Rep (TreeRevisionWithMetaData a) x -> TreeRevisionWithMetaData a # | |||||
| ToSchema a => ToSchema (TreeRevisionWithMetaData a) Source # | |||||
Defined in Docs.MetaTree Methods declareNamedSchema :: Proxy (TreeRevisionWithMetaData a) -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep (TreeRevisionWithMetaData a) Source # | |||||
Defined in Docs.MetaTree type Rep (TreeRevisionWithMetaData a) = D1 ('MetaData "TreeRevisionWithMetaData" "Docs.MetaTree" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TreeRevisionWithMetaData" 'PrefixI 'True) (S1 ('MetaSel ('Just "revisionHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TreeRevisionHeader) :*: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TreeWithMetaData a)))) | |||||