Safe Haskell	None
Language	Haskell2010

Web.Sprinkles.Rule

Synopsis

data RuleTarget p
- = TemplateTarget p
- | RedirectTarget p
- | StaticTarget (Maybe p)
- | JSONTarget
type Seconds = Integer
data ClientCacheSetting
- = NoCache
- | CacheForever
- | MaxAge Seconds
data SessionDirective
- = AcceptSession
- | IgnoreSession
- | CreateNewSession
- | RequireSession
data Rule = Rule {
- ruleRoutePattern :: Pattern
- ruleContextData :: AList Text BackendSpec
- ruleTarget :: RuleTarget Replacement
- ruleRequired :: Set Text
- ruleAcceptedMethods :: Set Method
- ruleCaching :: ClientCacheSetting
- ruleContentTypeOverride :: Maybe ByteString
- ruleSessionDirective :: SessionDirective
}
makeRulePathsAbsolute :: FilePath -> Rule -> Rule
orElse :: Monad m => m (Maybe a) -> m (Maybe a) -> m (Maybe a)
expandRuleTarget :: HashMap Text (GVal (Run SourcePos IO Text)) -> RuleTarget Replacement -> IO (RuleTarget Text)
expandReplacementBackend :: HashMap Text (GVal (Run SourcePos IO Text)) -> BackendSpec -> IO BackendSpec
data NonMatchReason
- = PathNotMatched
- | MethodNotMatched
(<|+>) :: Ord e => Either e a -> Either e a -> Either e a
matchMethod :: Set Method -> Method -> Maybe Method
matchRule :: Rule -> Method -> [Text] -> QueryText -> Either NonMatchReason (HashMap Text MatchedText)
applyRule :: Rule -> Method -> [Text] -> QueryText -> Either NonMatchReason (Rule, HashMap Text MatchedText)
applyRules :: [Rule] -> Method -> [Text] -> QueryText -> Either NonMatchReason (Rule, HashMap Text MatchedText)

Documentation

data RuleTarget p Source #

Constructors

TemplateTarget p
RedirectTarget p
StaticTarget (Maybe p)
JSONTarget

Instances

Eq p => Eq (RuleTarget p) Source #
Instance details Defined in Web.Sprinkles.Rule Methods (==) :: RuleTarget p -> RuleTarget p -> Bool # (/=) :: RuleTarget p -> RuleTarget p -> Bool #
Show p => Show (RuleTarget p) Source #
Instance details Defined in Web.Sprinkles.Rule Methods showsPrec :: Int -> RuleTarget p -> ShowS # show :: RuleTarget p -> String # showList :: [RuleTarget p] -> ShowS #

type Seconds = Integer Source #

data ClientCacheSetting Source #

Constructors

NoCache
CacheForever
MaxAge Seconds

Instances

Eq ClientCacheSetting Source #
Instance details Defined in Web.Sprinkles.Rule Methods (==) :: ClientCacheSetting -> ClientCacheSetting -> Bool # (/=) :: ClientCacheSetting -> ClientCacheSetting -> Bool #
Show ClientCacheSetting Source #
Instance details Defined in Web.Sprinkles.Rule Methods showsPrec :: Int -> ClientCacheSetting -> ShowS # show :: ClientCacheSetting -> String # showList :: [ClientCacheSetting] -> ShowS #
FromJSON ClientCacheSetting Source #
Instance details Defined in Web.Sprinkles.Rule Methods parseJSON :: Value -> Parser ClientCacheSetting # parseJSONList :: Value -> Parser [ClientCacheSetting] #

data SessionDirective Source #

Describes if and how to initialize a session for a request.

Constructors

AcceptSession	Accept if given, but do not require
IgnoreSession	Ignore all sessions
CreateNewSession	Always create a new session
RequireSession	Require a session, fail if none exists

Instances

Eq SessionDirective Source #
Instance details Defined in Web.Sprinkles.Rule Methods (==) :: SessionDirective -> SessionDirective -> Bool # (/=) :: SessionDirective -> SessionDirective -> Bool #
Show SessionDirective Source #
Instance details Defined in Web.Sprinkles.Rule Methods showsPrec :: Int -> SessionDirective -> ShowS # show :: SessionDirective -> String # showList :: [SessionDirective] -> ShowS #
FromJSON SessionDirective Source #
Instance details Defined in Web.Sprinkles.Rule Methods parseJSON :: Value -> Parser SessionDirective # parseJSONList :: Value -> Parser [SessionDirective] #

data Rule Source #

Constructors

Rule
Fields ruleRoutePattern :: Pattern ruleContextData :: AList Text BackendSpec ruleTarget :: RuleTarget Replacement ruleRequired :: Set Text ruleAcceptedMethods :: Set Method ruleCaching :: ClientCacheSetting ruleContentTypeOverride :: Maybe ByteString ruleSessionDirective :: SessionDirective

Instances

Show Rule Source #
Instance details Defined in Web.Sprinkles.Rule Methods showsPrec :: Int -> Rule -> ShowS # show :: Rule -> String # showList :: [Rule] -> ShowS #
FromJSON Rule Source #
Instance details Defined in Web.Sprinkles.Rule Methods parseJSON :: Value -> Parser Rule # parseJSONList :: Value -> Parser [Rule] #

makeRulePathsAbsolute :: FilePath -> Rule -> Rule Source #

orElse :: Monad m => m (Maybe a) -> m (Maybe a) -> m (Maybe a) Source #

expandRuleTarget :: HashMap Text (GVal (Run SourcePos IO Text)) -> RuleTarget Replacement -> IO (RuleTarget Text) Source #

expandReplacementBackend :: HashMap Text (GVal (Run SourcePos IO Text)) -> BackendSpec -> IO BackendSpec Source #

data NonMatchReason Source #

Constructors

PathNotMatched
MethodNotMatched

Instances

Enum NonMatchReason Source #
Instance details Defined in Web.Sprinkles.Rule Methods succ :: NonMatchReason -> NonMatchReason # pred :: NonMatchReason -> NonMatchReason # toEnum :: Int -> NonMatchReason # fromEnum :: NonMatchReason -> Int # enumFrom :: NonMatchReason -> [NonMatchReason] # enumFromThen :: NonMatchReason -> NonMatchReason -> [NonMatchReason] # enumFromTo :: NonMatchReason -> NonMatchReason -> [NonMatchReason] # enumFromThenTo :: NonMatchReason -> NonMatchReason -> NonMatchReason -> [NonMatchReason] #
Eq NonMatchReason Source #
Instance details Defined in Web.Sprinkles.Rule Methods (==) :: NonMatchReason -> NonMatchReason -> Bool # (/=) :: NonMatchReason -> NonMatchReason -> Bool #
Ord NonMatchReason Source #
Instance details Defined in Web.Sprinkles.Rule Methods compare :: NonMatchReason -> NonMatchReason -> Ordering # (<) :: NonMatchReason -> NonMatchReason -> Bool # (<=) :: NonMatchReason -> NonMatchReason -> Bool # (>) :: NonMatchReason -> NonMatchReason -> Bool # (>=) :: NonMatchReason -> NonMatchReason -> Bool # max :: NonMatchReason -> NonMatchReason -> NonMatchReason # min :: NonMatchReason -> NonMatchReason -> NonMatchReason #
Read NonMatchReason Source #
Instance details Defined in Web.Sprinkles.Rule Methods readsPrec :: Int -> ReadS NonMatchReason # readList :: ReadS [NonMatchReason] # readPrec :: ReadPrec NonMatchReason # readListPrec :: ReadPrec [NonMatchReason] #
Show NonMatchReason Source #
Instance details Defined in Web.Sprinkles.Rule Methods showsPrec :: Int -> NonMatchReason -> ShowS # show :: NonMatchReason -> String # showList :: [NonMatchReason] -> ShowS #

(<|+>) :: Ord e => Either e a -> Either e a -> Either e a Source #

Alternative-like monoid append operator for Eithers over orderable Lefts. The behavior is almost exactly like Alternative proper, except that when both sides fail, the larger failure value prevails.

In other words:

matchMethod :: Set Method -> Method -> Maybe Method Source #

matchRule :: Rule -> Method -> [Text] -> QueryText -> Either NonMatchReason (HashMap Text MatchedText) Source #

applyRule :: Rule -> Method -> [Text] -> QueryText -> Either NonMatchReason (Rule, HashMap Text MatchedText) Source #

applyRules :: [Rule] -> Method -> [Text] -> QueryText -> Either NonMatchReason (Rule, HashMap Text MatchedText) Source #