Emanote.Route.R

Documentation

newtype R (ext :: FileType a)

Represents the relative path to some file (or its isomporphic URL represetation).

Constructors

R

Fields

• unRoute :: NonEmpty Slug

Instances

Indexable NoteIxs Note

Defined in Emanote.Model.Note

Methods

indices :: IxList NoteIxs Note

Indexable SDataIxs SData

Defined in Emanote.Model.SData

Methods

indices :: IxList SDataIxs SData

Indexable StaticFileIxs StaticFile

Defined in Emanote.Model.StaticFile

Methods

indices :: IxList StaticFileIxs StaticFile

HasExt ext => ToJSON (R ext)

Defined in Emanote.Route.R

Methods

toJSON :: R ext -> Value

toEncoding :: R ext -> Encoding

toJSONList :: [R ext] -> Value

toEncodingList :: [R ext] -> Encoding

(Typeable a, Typeable ext) => Data (R ext)

Defined in Emanote.Route.R

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> R ext -> c (R ext)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (R ext)

toConstr :: R ext -> Constr

dataTypeOf :: R ext -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (R ext))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (R ext))

gmapT :: (forall b. Data b => b -> b) -> R ext -> R ext

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> R ext -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> R ext -> r

gmapQ :: (forall d. Data d => d -> u) -> R ext -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> R ext -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> R ext -> m (R ext)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> R ext -> m (R ext)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> R ext -> m (R ext)

HasExt ext => Show (R ext)

Defined in Emanote.Route.R

Methods

showsPrec :: Int -> R ext -> ShowS

show :: R ext -> String

showList :: [R ext] -> ShowS

Eq (R ext)

Defined in Emanote.Route.R

Methods

(==) :: R ext -> R ext -> Bool

(/=) :: R ext -> R ext -> Bool

Ord (R ext)

Defined in Emanote.Route.R

Methods

compare :: R ext -> R ext -> Ordering

(<) :: R ext -> R ext -> Bool

(<=) :: R ext -> R ext -> Bool

(>) :: R ext -> R ext -> Bool

(>=) :: R ext -> R ext -> Bool

max :: R ext -> R ext -> R ext

min :: R ext -> R ext -> R ext

mkRouteFromFilePath :: forall a (ext :: FileType a). HasExt ext => FilePath -> Maybe (R ext)

Convert foo/bar.ext to a R

mkRouteFromSlugs :: NonEmpty Slug -> R ext

routeSlug :: R ext -> Maybe Slug

If the route is a single-slug URL, return the only slug.

routeSlugWithPrefix :: NonEmpty Slug -> R ext -> Maybe Slug

Like routeSlug but skips the given prefixes, returning the (only) pending slug.

routeBaseName :: R ext -> Text

The base name of the route without its parent path.

routeParent :: R ext -> Maybe (R 'Folder)

routeInits :: R ext -> NonEmpty (R ext)

For use in breadcrumbs

indexRoute :: R ext

encodeRoute :: forall a (ft :: FileType a). HasExt ft => R ft -> FilePath

Convert a route to filepath

decodeHtmlRoute :: FilePath -> R 'Html

Parse our route from html file path

decodeAnyRoute :: FilePath -> Maybe (R 'AnyExt)