hakyll-4.13.0.1: A static website compiler library

Safe Haskell | None
Language | Haskell2010

Hakyll.Core.Identifier

Description

An identifier is a type used to uniquely identify an item. An identifier is conceptually similar to a file path. Examples of identifiers are:

-     posts/foo.markdown

-     index

-     error/404

Synopsis

- data Identifier
- fromFilePath :: FilePath -> Identifier
- toFilePath :: Identifier -> FilePath
- identifierVersion :: Identifier -> Maybe String
- setVersion :: Maybe String -> Identifier -> Identifier

# Documentation

data Identifier Source #

Instances

Eq Identifier Source # |
Instance details Defined in Hakyll.Core.Identifier Methods (==) :: Identifier -> Identifier -> Bool Source # (/=) :: Identifier -> Identifier -> Bool Source #
Ord Identifier Source # |

Instance details

Defined in Hakyll.Core.Identifier

Methods

compare :: Identifier -> Identifier -> Ordering Source #

(<) :: Identifier -> Identifier -> Bool Source #

(<=) :: Identifier -> Identifier -> Bool Source #

(>) :: Identifier -> Identifier -> Bool Source #

(>=) :: Identifier -> Identifier -> Bool Source #

max :: Identifier -> Identifier -> Identifier Source #

min :: Identifier -> Identifier -> Identifier Source #

Show Identifier Source # |
Instance details Defined in Hakyll.Core.Identifier Methods showsPrec :: Int -> Identifier -> ShowS Source # show :: Identifier -> String Source # showList :: [Identifier] -> ShowS Source #
IsString Identifier Source # |
Instance details Defined in Hakyll.Core.Identifier Methods fromString :: String -> Identifier Source #
Binary Identifier Source # |
Instance details Defined in Hakyll.Core.Identifier Methods put :: Identifier -> Put Source # get :: Get Identifier Source # putList :: [Identifier] -> Put Source #
NFData Identifier Source # |
Instance details Defined in Hakyll.Core.Identifier Methods rnf :: Identifier -> () Source #

fromFilePath :: FilePath -> Identifier Source #

Parse an identifier from a string

toFilePath :: Identifier -> FilePath Source #

Convert an identifier to a relative `FilePath`

identifierVersion :: Identifier -> Maybe String Source #

setVersion :: Maybe String -> Identifier -> Identifier Source #