Emanote.Route.ModelRoute

Route types representing the resources in our Model.

See also: SiteRoute.

Documentation

data ModelRoute

A R to anywhere in Model

Constructors

ModelRoute_StaticFile StaticFileRoute

ModelRoute_LML LMLRoute

Instances

ToJSON ModelRoute

Defined in Emanote.Route.ModelRoute

Methods

toJSON :: ModelRoute -> Value

toEncoding :: ModelRoute -> Encoding

toJSONList :: [ModelRoute] -> Value

toEncodingList :: [ModelRoute] -> Encoding

Generic ModelRoute

Defined in Emanote.Route.ModelRoute

Associated Types

type Rep ModelRoute :: Type -> Type

Methods

from :: ModelRoute -> Rep ModelRoute x

to :: Rep ModelRoute x -> ModelRoute

Show ModelRoute

Defined in Emanote.Route.ModelRoute

Methods

showsPrec :: Int -> ModelRoute -> ShowS

show :: ModelRoute -> String

showList :: [ModelRoute] -> ShowS

Eq ModelRoute

Defined in Emanote.Route.ModelRoute

Methods

(==) :: ModelRoute -> ModelRoute -> Bool

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

Ord ModelRoute

Defined in Emanote.Route.ModelRoute

Methods

compare :: ModelRoute -> ModelRoute -> Ordering

(<) :: ModelRoute -> ModelRoute -> Bool

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

(>) :: ModelRoute -> ModelRoute -> Bool

(>=) :: ModelRoute -> ModelRoute -> Bool

max :: ModelRoute -> ModelRoute -> ModelRoute

min :: ModelRoute -> ModelRoute -> ModelRoute

type Rep ModelRoute

Defined in Emanote.Route.ModelRoute

type Rep ModelRoute = D1 ('MetaData "ModelRoute" "Emanote.Route.ModelRoute" "emanote-1.0.0.0-inplace" 'False) (C1 ('MetaCons "ModelRoute_StaticFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StaticFileRoute)) :+: C1 ('MetaCons "ModelRoute_LML" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LMLRoute)))

modelRouteCase :: ModelRoute -> Either LMLRoute StaticFileRoute

mkModelRouteFromFilePath :: FilePath -> Maybe ModelRoute

data LMLRoute

R to a note file in LML (lightweight markup language) format

Constructors

LMLRoute_Md (R ('LMLType 'Md))

LMLRoute_Org (R ('LMLType 'Org))

Instances

ToJSON LMLRoute

Defined in Emanote.Route.ModelRoute

Methods

toJSON :: LMLRoute -> Value

toEncoding :: LMLRoute -> Encoding

toJSONList :: [LMLRoute] -> Value

toEncodingList :: [LMLRoute] -> Encoding

Generic LMLRoute

Defined in Emanote.Route.ModelRoute

Associated Types

type Rep LMLRoute :: Type -> Type

Methods

from :: LMLRoute -> Rep LMLRoute x

to :: Rep LMLRoute x -> LMLRoute

Show LMLRoute

Defined in Emanote.Route.ModelRoute

Methods

showsPrec :: Int -> LMLRoute -> ShowS

show :: LMLRoute -> String

showList :: [LMLRoute] -> ShowS

Eq LMLRoute

Defined in Emanote.Route.ModelRoute

Methods

(==) :: LMLRoute -> LMLRoute -> Bool

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

Ord LMLRoute

Defined in Emanote.Route.ModelRoute

Methods

compare :: LMLRoute -> LMLRoute -> Ordering

(<) :: LMLRoute -> LMLRoute -> Bool

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

(>) :: LMLRoute -> LMLRoute -> Bool

(>=) :: LMLRoute -> LMLRoute -> Bool

max :: LMLRoute -> LMLRoute -> LMLRoute

min :: LMLRoute -> LMLRoute -> LMLRoute

Indexable RelIxs Rel

Defined in Emanote.Model.Link.Rel

Methods

indices :: IxList RelIxs Rel

Indexable NoteIxs Note

Defined in Emanote.Model.Note

Methods

indices :: IxList NoteIxs Note

Indexable TaskIxs Task

Defined in Emanote.Model.Task

Methods

indices :: IxList TaskIxs Task

type Rep LMLRoute

Defined in Emanote.Route.ModelRoute

type Rep LMLRoute = D1 ('MetaData "LMLRoute" "Emanote.Route.ModelRoute" "emanote-1.0.0.0-inplace" 'False) (C1 ('MetaCons "LMLRoute_Md" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (R ('LMLType 'Md)))) :+: C1 ('MetaCons "LMLRoute_Org" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (R ('LMLType 'Org)))))

defaultLmlRoute :: R (ext :: FileType a) -> LMLRoute

possibleLmlRoutes :: R (ext :: FileType a) -> [LMLRoute]

lmlRouteCase :: LMLRoute -> Either (R ('LMLType 'Md)) (R ('LMLType 'Org))

withLmlRoute :: (forall lmlType. HasExt ('LMLType lmlType) => R ('LMLType lmlType) -> r) -> LMLRoute -> r

mkLMLRouteFromFilePath :: FilePath -> Maybe LMLRoute

mkLMLRouteFromKnownFilePath :: LML -> FilePath -> Maybe LMLRoute

Like mkLMLRouteFromFilePath, but when the file extension is known ahead to be of lmlType.

isMdRoute :: LMLRoute -> Bool

type StaticFileRoute = R 'AnyExt