Headroom.Template.TemplateRef

TemplateRef data type represents reference to template file, either local or remote, which can be later opened/downloaded and parsed into template.

Data Types

data TemplateRef

Reference to the template (e.g. local file, URI address).

Constructors

InlineRef Text

LocalTemplateRef FilePath

template path on local file system

UriTemplateRef URI

remote template URI adress

BuiltInRef LicenseType FileType

Instances

Eq TemplateRef

Defined in Headroom.Template.TemplateRef

Methods

(==) :: TemplateRef -> TemplateRef -> Bool

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

Ord TemplateRef

Defined in Headroom.Template.TemplateRef

Methods

compare :: TemplateRef -> TemplateRef -> Ordering

(<) :: TemplateRef -> TemplateRef -> Bool

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

(>) :: TemplateRef -> TemplateRef -> Bool

(>=) :: TemplateRef -> TemplateRef -> Bool

max :: TemplateRef -> TemplateRef -> TemplateRef

min :: TemplateRef -> TemplateRef -> TemplateRef

Show TemplateRef

Defined in Headroom.Template.TemplateRef

Methods

showsPrec :: Int -> TemplateRef -> ShowS

show :: TemplateRef -> String

showList :: [TemplateRef] -> ShowS

FromJSON TemplateRef

Defined in Headroom.Template.TemplateRef

Methods

parseJSON :: Value -> Parser TemplateRef

parseJSONList :: Value -> Parser [TemplateRef]

Constructor Functions

mkTemplateRef

Arguments

:: MonadThrow m

=> Text

input text

-> m TemplateRef

created TemplateRef (or error)

Creates a TemplateRef from given text. If the raw text appears to be valid URL with either http or https as protocol, it considers it as UriTemplateRef, otherwise it creates LocalTemplateRef.

>>> mkTemplateRef "/path/to/haskell.mustache" :: Maybe TemplateRef
Just (LocalTemplateRef "/path/to/haskell.mustache")

>>> mkTemplateRef "https://foo.bar/haskell.mustache" :: Maybe TemplateRef
Just (UriTemplateRef (URI {uriScheme = Just "https", uriAuthority = Right (Authority {authUserInfo = Nothing, authHost = "foo.bar", authPort = Nothing}), uriPath = Just (False,"haskell.mustache" :| []), uriQuery = [], uriFragment = Nothing}))

Public Functions

renderRef

Arguments

:: TemplateRef

TemplateRef to render

-> Text

rendered text

Renders given TemplateRef into human-friendly text.

Error Types

data TemplateRefError

Error related to template references.

Constructors

UnrecognizedTemplateName Text

not a valid format for template name

UnsupportedUriProtocol Text Text

URI protocol not supported

Instances

Eq TemplateRefError

Defined in Headroom.Template.TemplateRef

Methods

(==) :: TemplateRefError -> TemplateRefError -> Bool

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

Show TemplateRefError

Defined in Headroom.Template.TemplateRef

Methods

showsPrec :: Int -> TemplateRefError -> ShowS

show :: TemplateRefError -> String

showList :: [TemplateRefError] -> ShowS

Exception TemplateRefError

Defined in Headroom.Template.TemplateRef

Methods

toException :: TemplateRefError -> SomeException

fromException :: SomeException -> Maybe TemplateRefError

displayException :: TemplateRefError -> String