Safe Haskell	Safe-Inferred
Language	GHC2021

CookieTray

Contents

Command
Tray
Name
Value
Expiry
Meta
- Security
- Scope

Synopsis

render :: ToCommandList a => a -> [BinaryCommand]
renderLBS :: ToCommandList a => a -> [ByteString]
class ToCommandList a where
- toCommandList :: a -> [Command]
data Command
data Action a
- = Delete
- | Put a
renderCommand :: Command -> BinaryCommand
data BinaryCommand
binaryCommandByteStringLazy :: BinaryCommand -> ByteString
newtype Tray a = Tray (Map Name a)
parse :: ByteString -> Tray Value
lookup :: Name -> Tray a -> Maybe a
fromList :: [Named a] -> Tray a
toList :: Tray a -> [Named a]
newtype Name = Name {
- nameByteString :: ByteString
}
data Named a = Named {
- name :: Name
- value :: a
}
newtype Value = Value {
- valueByteString :: ByteString
}
data Expiry
- = ExpiryTime UTCTime
- | ExpiryAge DiffTime
data Expiring a = Expiring {
- expiry :: Expiry
- expiring :: a
}
data Security = Security {
- jsAccess :: JavascriptAccess
- origin :: Origin
}
data Secured a = Secured {
- security :: Security
- secured :: a
}
data Origin
- = SameSite SameSiteOptions
- | CrossSite
data TransportEncryption
- = RequireEncryptedTransport
- | AllowUnencryptedTransport
data SameSiteOptions = SameSiteOptions {
- sameSiteStrictness :: SameSiteStrictness
- transportEncryption :: TransportEncryption
}
data SameSiteStrictness
- = SameSiteStrict
- | SameSiteLax
data JavascriptAccess
- = HiddenFromJavascript
- | AccessibleFromJavascript
data Scope = Scope {
- domain :: Domain
- path :: Path
}
data Domain
- = Domain ByteString
- | CurrentHostExcludingSubdomains
data Path
- = Path ByteString
- | CurrentPath
data Meta = Meta {
- metaScope :: Scope
- metaSecurity :: Security
}

Command

render :: ToCommandList a => a -> [BinaryCommand] Source #

renderLBS :: ToCommandList a => a -> [ByteString] Source #

class ToCommandList a where Source #

Methods

toCommandList :: a -> [Command] Source #

Instances

Instances details

ToCommandList Command Source #
Instance details Defined in CookieTray.Command Methods toCommandList :: Command -> [Command] Source #
ToCommandList Many Source #
Instance details Defined in CookieTray.Command.Many Methods toCommandList :: Many -> [Command] Source #
ToCommandList PutMany Source #
Instance details Defined in CookieTray.Command.PutMany Methods toCommandList :: PutMany -> [Command] Source #
ToCommandList PutOne Source #
Instance details Defined in CookieTray.Command.PutOne Methods toCommandList :: PutOne -> [Command] Source #

data Command Source #

Instances

Instances details

Show Command Source #
Instance details Defined in CookieTray.Command Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
ToCommandList Command Source #
Instance details Defined in CookieTray.Command Methods toCommandList :: Command -> [Command] Source #
Eq Command Source #
Instance details Defined in CookieTray.Command Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #
Ord Command Source #
Instance details Defined in CookieTray.Command Methods compare :: Command -> Command -> Ordering # (<) :: Command -> Command -> Bool # (<=) :: Command -> Command -> Bool # (>) :: Command -> Command -> Bool # (>=) :: Command -> Command -> Bool # max :: Command -> Command -> Command # min :: Command -> Command -> Command #

data Action a Source #

Constructors

Delete
Put a

Instances

Instances details

Functor Action Source #
Instance details Defined in CookieTray.Types Methods fmap :: (a -> b) -> Action a -> Action b # (<$) :: a -> Action b -> Action a #
Show a => Show (Action a) Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Action a -> ShowS # show :: Action a -> String # showList :: [Action a] -> ShowS #
Eq a => Eq (Action a) Source #
Instance details Defined in CookieTray.Types Methods (==) :: Action a -> Action a -> Bool # (/=) :: Action a -> Action a -> Bool #
Ord a => Ord (Action a) Source #
Instance details Defined in CookieTray.Types Methods compare :: Action a -> Action a -> Ordering # (<) :: Action a -> Action a -> Bool # (<=) :: Action a -> Action a -> Bool # (>) :: Action a -> Action a -> Bool # (>=) :: Action a -> Action a -> Bool # max :: Action a -> Action a -> Action a # min :: Action a -> Action a -> Action a #

renderCommand :: Command -> BinaryCommand Source #

data BinaryCommand Source #

The raw content of a set-cookie header

Instances

Instances details

IsString BinaryCommand Source #
Instance details Defined in CookieTray.Types Methods fromString :: String -> BinaryCommand #
Show BinaryCommand Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> BinaryCommand -> ShowS # show :: BinaryCommand -> String # showList :: [BinaryCommand] -> ShowS #
Eq BinaryCommand Source #
Instance details Defined in CookieTray.Types Methods (==) :: BinaryCommand -> BinaryCommand -> Bool # (/=) :: BinaryCommand -> BinaryCommand -> Bool #
Ord BinaryCommand Source #
Instance details Defined in CookieTray.Types Methods compare :: BinaryCommand -> BinaryCommand -> Ordering # (<) :: BinaryCommand -> BinaryCommand -> Bool # (<=) :: BinaryCommand -> BinaryCommand -> Bool # (>) :: BinaryCommand -> BinaryCommand -> Bool # (>=) :: BinaryCommand -> BinaryCommand -> Bool # max :: BinaryCommand -> BinaryCommand -> BinaryCommand # min :: BinaryCommand -> BinaryCommand -> BinaryCommand #

binaryCommandByteStringLazy :: BinaryCommand -> ByteString Source #

Tray

newtype Tray a Source #

Constructors

Tray (Map Name a)

Instances

Instances details

Functor Tray Source #
Instance details Defined in CookieTray Methods fmap :: (a -> b) -> Tray a -> Tray b # (<$) :: a -> Tray b -> Tray a #
Monoid (Tray a) Source #
Instance details Defined in CookieTray Methods mempty :: Tray a # mappend :: Tray a -> Tray a -> Tray a # mconcat :: [Tray a] -> Tray a #
Semigroup (Tray a) Source #	Left-biased map union
Instance details Defined in CookieTray Methods (<>) :: Tray a -> Tray a -> Tray a # sconcat :: NonEmpty (Tray a) -> Tray a # stimes :: Integral b => b -> Tray a -> Tray a #
IsList (Tray a) Source #
Instance details Defined in CookieTray Associated Types type Item (Tray a) # Methods fromList :: [Item (Tray a)] -> Tray a # fromListN :: Int -> [Item (Tray a)] -> Tray a # toList :: Tray a -> [Item (Tray a)] #
Show a => Show (Tray a) Source #
Instance details Defined in CookieTray Methods showsPrec :: Int -> Tray a -> ShowS # show :: Tray a -> String # showList :: [Tray a] -> ShowS #
Eq a => Eq (Tray a) Source #
Instance details Defined in CookieTray Methods (==) :: Tray a -> Tray a -> Bool # (/=) :: Tray a -> Tray a -> Bool #
Ord a => Ord (Tray a) Source #
Instance details Defined in CookieTray Methods compare :: Tray a -> Tray a -> Ordering # (<) :: Tray a -> Tray a -> Bool # (<=) :: Tray a -> Tray a -> Bool # (>) :: Tray a -> Tray a -> Bool # (>=) :: Tray a -> Tray a -> Bool # max :: Tray a -> Tray a -> Tray a # min :: Tray a -> Tray a -> Tray a #
type Item (Tray a) Source #
Instance details Defined in CookieTray type Item (Tray a) = Named a

parse :: ByteString -> Tray Value Source #

lookup :: Name -> Tray a -> Maybe a Source #

fromList :: [Named a] -> Tray a Source #

toList :: Tray a -> [Named a] Source #

Name

newtype Name Source #

Constructors

Name
Fields nameByteString :: ByteString

Instances

Instances details

IsString Name Source #
Instance details Defined in CookieTray.Types Methods fromString :: String -> Name #
Show Name Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
Eq Name Source #
Instance details Defined in CookieTray.Types Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Instance details Defined in CookieTray.Types Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #

data Named a Source #

Constructors

Named
Fields name :: Name value :: a

Instances

Instances details

Show a => Show (Named a) Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Named a -> ShowS # show :: Named a -> String # showList :: [Named a] -> ShowS #
Eq a => Eq (Named a) Source #
Instance details Defined in CookieTray.Types Methods (==) :: Named a -> Named a -> Bool # (/=) :: Named a -> Named a -> Bool #
Ord a => Ord (Named a) Source #
Instance details Defined in CookieTray.Types Methods compare :: Named a -> Named a -> Ordering # (<) :: Named a -> Named a -> Bool # (<=) :: Named a -> Named a -> Bool # (>) :: Named a -> Named a -> Bool # (>=) :: Named a -> Named a -> Bool # max :: Named a -> Named a -> Named a # min :: Named a -> Named a -> Named a #

Value

newtype Value Source #

Constructors

Value
Fields valueByteString :: ByteString

Instances

Instances details

IsString Value Source #
Instance details Defined in CookieTray.Types Methods fromString :: String -> Value #
Show Value Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
Eq Value Source #
Instance details Defined in CookieTray.Types Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
Ord Value Source #
Instance details Defined in CookieTray.Types Methods compare :: Value -> Value -> Ordering # (<) :: Value -> Value -> Bool # (<=) :: Value -> Value -> Bool # (>) :: Value -> Value -> Bool # (>=) :: Value -> Value -> Bool # max :: Value -> Value -> Value # min :: Value -> Value -> Value #

Expiry

data Expiry Source #

Constructors

ExpiryTime UTCTime
ExpiryAge DiffTime

Instances

Instances details

Show Expiry Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Expiry -> ShowS # show :: Expiry -> String # showList :: [Expiry] -> ShowS #
Eq Expiry Source #
Instance details Defined in CookieTray.Types Methods (==) :: Expiry -> Expiry -> Bool # (/=) :: Expiry -> Expiry -> Bool #
Ord Expiry Source #
Instance details Defined in CookieTray.Types Methods compare :: Expiry -> Expiry -> Ordering # (<) :: Expiry -> Expiry -> Bool # (<=) :: Expiry -> Expiry -> Bool # (>) :: Expiry -> Expiry -> Bool # (>=) :: Expiry -> Expiry -> Bool # max :: Expiry -> Expiry -> Expiry # min :: Expiry -> Expiry -> Expiry #

data Expiring a Source #

Constructors

Expiring
Fields expiry :: Expiry expiring :: a

Instances

Instances details

Functor Expiring Source #
Instance details Defined in CookieTray.Types Methods fmap :: (a -> b) -> Expiring a -> Expiring b # (<$) :: a -> Expiring b -> Expiring a #
Show a => Show (Expiring a) Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Expiring a -> ShowS # show :: Expiring a -> String # showList :: [Expiring a] -> ShowS #
Eq a => Eq (Expiring a) Source #
Instance details Defined in CookieTray.Types Methods (==) :: Expiring a -> Expiring a -> Bool # (/=) :: Expiring a -> Expiring a -> Bool #
Ord a => Ord (Expiring a) Source #
Instance details Defined in CookieTray.Types Methods compare :: Expiring a -> Expiring a -> Ordering # (<) :: Expiring a -> Expiring a -> Bool # (<=) :: Expiring a -> Expiring a -> Bool # (>) :: Expiring a -> Expiring a -> Bool # (>=) :: Expiring a -> Expiring a -> Bool # max :: Expiring a -> Expiring a -> Expiring a # min :: Expiring a -> Expiring a -> Expiring a #

Meta

Security

data Security Source #

Constructors

Security
Fields jsAccess :: JavascriptAccess origin :: Origin

Instances

Instances details

Show Security Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Security -> ShowS # show :: Security -> String # showList :: [Security] -> ShowS #
Eq Security Source #
Instance details Defined in CookieTray.Types Methods (==) :: Security -> Security -> Bool # (/=) :: Security -> Security -> Bool #
Ord Security Source #
Instance details Defined in CookieTray.Types Methods compare :: Security -> Security -> Ordering # (<) :: Security -> Security -> Bool # (<=) :: Security -> Security -> Bool # (>) :: Security -> Security -> Bool # (>=) :: Security -> Security -> Bool # max :: Security -> Security -> Security # min :: Security -> Security -> Security #

data Secured a Source #

Constructors

Secured
Fields security :: Security secured :: a

Instances

Instances details

Functor Secured Source #
Instance details Defined in CookieTray.Types Methods fmap :: (a -> b) -> Secured a -> Secured b # (<$) :: a -> Secured b -> Secured a #
Show a => Show (Secured a) Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Secured a -> ShowS # show :: Secured a -> String # showList :: [Secured a] -> ShowS #
Eq a => Eq (Secured a) Source #
Instance details Defined in CookieTray.Types Methods (==) :: Secured a -> Secured a -> Bool # (/=) :: Secured a -> Secured a -> Bool #
Ord a => Ord (Secured a) Source #
Instance details Defined in CookieTray.Types Methods compare :: Secured a -> Secured a -> Ordering # (<) :: Secured a -> Secured a -> Bool # (<=) :: Secured a -> Secured a -> Bool # (>) :: Secured a -> Secured a -> Bool # (>=) :: Secured a -> Secured a -> Bool # max :: Secured a -> Secured a -> Secured a # min :: Secured a -> Secured a -> Secured a #

data Origin Source #

Constructors

SameSite SameSiteOptions
CrossSite	Instruct the client to send the cookie for all requests, even those originating from a third party. This option implies `RequireEncryptedTransport`.

Instances

Instances details

Show Origin Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Origin -> ShowS # show :: Origin -> String # showList :: [Origin] -> ShowS #
Eq Origin Source #
Instance details Defined in CookieTray.Types Methods (==) :: Origin -> Origin -> Bool # (/=) :: Origin -> Origin -> Bool #
Ord Origin Source #
Instance details Defined in CookieTray.Types Methods compare :: Origin -> Origin -> Ordering # (<) :: Origin -> Origin -> Bool # (<=) :: Origin -> Origin -> Bool # (>) :: Origin -> Origin -> Bool # (>=) :: Origin -> Origin -> Bool # max :: Origin -> Origin -> Origin # min :: Origin -> Origin -> Origin #

data TransportEncryption Source #

Constructors

RequireEncryptedTransport	The browser only sends cookies over HTTP, not HTTP
AllowUnencryptedTransport	The browser sends cookies regardless of transport encryption

Instances

Instances details

Show TransportEncryption Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> TransportEncryption -> ShowS # show :: TransportEncryption -> String # showList :: [TransportEncryption] -> ShowS #
Eq TransportEncryption Source #
Instance details Defined in CookieTray.Types Methods (==) :: TransportEncryption -> TransportEncryption -> Bool # (/=) :: TransportEncryption -> TransportEncryption -> Bool #
Ord TransportEncryption Source #
Instance details Defined in CookieTray.Types Methods compare :: TransportEncryption -> TransportEncryption -> Ordering # (<) :: TransportEncryption -> TransportEncryption -> Bool # (<=) :: TransportEncryption -> TransportEncryption -> Bool # (>) :: TransportEncryption -> TransportEncryption -> Bool # (>=) :: TransportEncryption -> TransportEncryption -> Bool # max :: TransportEncryption -> TransportEncryption -> TransportEncryption # min :: TransportEncryption -> TransportEncryption -> TransportEncryption #

data SameSiteOptions Source #

Constructors

SameSiteOptions
Fields sameSiteStrictness :: SameSiteStrictness transportEncryption :: TransportEncryption

Instances

Instances details

Show SameSiteOptions Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> SameSiteOptions -> ShowS # show :: SameSiteOptions -> String # showList :: [SameSiteOptions] -> ShowS #
Eq SameSiteOptions Source #
Instance details Defined in CookieTray.Types Methods (==) :: SameSiteOptions -> SameSiteOptions -> Bool # (/=) :: SameSiteOptions -> SameSiteOptions -> Bool #
Ord SameSiteOptions Source #
Instance details Defined in CookieTray.Types Methods compare :: SameSiteOptions -> SameSiteOptions -> Ordering # (<) :: SameSiteOptions -> SameSiteOptions -> Bool # (<=) :: SameSiteOptions -> SameSiteOptions -> Bool # (>) :: SameSiteOptions -> SameSiteOptions -> Bool # (>=) :: SameSiteOptions -> SameSiteOptions -> Bool # max :: SameSiteOptions -> SameSiteOptions -> SameSiteOptions # min :: SameSiteOptions -> SameSiteOptions -> SameSiteOptions #

data SameSiteStrictness Source #

Constructors

SameSiteStrict	Instruct the client not to send the cookie for requests originating from another site, e.g. if a user clicked a link from another site to yours. This setting offers the strongest protection against cross-site request forgery, but does not make sense in a lot of cases. (If somebody follows a link to your site, should they appear to be logged out?)
SameSiteLax	The client will send the cookie whenever your domain is what appears in the navigation bar

Instances

Instances details

Show SameSiteStrictness Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> SameSiteStrictness -> ShowS # show :: SameSiteStrictness -> String # showList :: [SameSiteStrictness] -> ShowS #
Eq SameSiteStrictness Source #
Instance details Defined in CookieTray.Types Methods (==) :: SameSiteStrictness -> SameSiteStrictness -> Bool # (/=) :: SameSiteStrictness -> SameSiteStrictness -> Bool #
Ord SameSiteStrictness Source #
Instance details Defined in CookieTray.Types Methods compare :: SameSiteStrictness -> SameSiteStrictness -> Ordering # (<) :: SameSiteStrictness -> SameSiteStrictness -> Bool # (<=) :: SameSiteStrictness -> SameSiteStrictness -> Bool # (>) :: SameSiteStrictness -> SameSiteStrictness -> Bool # (>=) :: SameSiteStrictness -> SameSiteStrictness -> Bool # max :: SameSiteStrictness -> SameSiteStrictness -> SameSiteStrictness # min :: SameSiteStrictness -> SameSiteStrictness -> SameSiteStrictness #

data JavascriptAccess Source #

Constructors

HiddenFromJavascript	HttpOnly; javascript cannot access the cookie
AccessibleFromJavascript	Cookie will be accessible from javascript, see https://developer.mozilla.org/en-US/docs/web/api/document/cookie

Instances

Instances details

Show JavascriptAccess Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> JavascriptAccess -> ShowS # show :: JavascriptAccess -> String # showList :: [JavascriptAccess] -> ShowS #
Eq JavascriptAccess Source #
Instance details Defined in CookieTray.Types Methods (==) :: JavascriptAccess -> JavascriptAccess -> Bool # (/=) :: JavascriptAccess -> JavascriptAccess -> Bool #
Ord JavascriptAccess Source #
Instance details Defined in CookieTray.Types Methods compare :: JavascriptAccess -> JavascriptAccess -> Ordering # (<) :: JavascriptAccess -> JavascriptAccess -> Bool # (<=) :: JavascriptAccess -> JavascriptAccess -> Bool # (>) :: JavascriptAccess -> JavascriptAccess -> Bool # (>=) :: JavascriptAccess -> JavascriptAccess -> Bool # max :: JavascriptAccess -> JavascriptAccess -> JavascriptAccess # min :: JavascriptAccess -> JavascriptAccess -> JavascriptAccess #

Scope

data Scope Source #

Constructors

Scope
Fields domain :: Domain path :: Path

Instances

Instances details

Show Scope Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #
Eq Scope Source #
Instance details Defined in CookieTray.Types Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #
Ord Scope Source #
Instance details Defined in CookieTray.Types Methods compare :: Scope -> Scope -> Ordering # (<) :: Scope -> Scope -> Bool # (<=) :: Scope -> Scope -> Bool # (>) :: Scope -> Scope -> Bool # (>=) :: Scope -> Scope -> Bool # max :: Scope -> Scope -> Scope # min :: Scope -> Scope -> Scope #

data Domain Source #

The host to which the cookie will be sent

Constructors

Domain ByteString
CurrentHostExcludingSubdomains

Instances

Instances details

Show Domain Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Domain -> ShowS # show :: Domain -> String # showList :: [Domain] -> ShowS #
Eq Domain Source #
Instance details Defined in CookieTray.Types Methods (==) :: Domain -> Domain -> Bool # (/=) :: Domain -> Domain -> Bool #
Ord Domain Source #
Instance details Defined in CookieTray.Types Methods compare :: Domain -> Domain -> Ordering # (<) :: Domain -> Domain -> Bool # (<=) :: Domain -> Domain -> Bool # (>) :: Domain -> Domain -> Bool # (>=) :: Domain -> Domain -> Bool # max :: Domain -> Domain -> Domain # min :: Domain -> Domain -> Domain #

data Path Source #

Constructors

Path ByteString
CurrentPath

Instances

Instances details

Show Path Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
Eq Path Source #
Instance details Defined in CookieTray.Types Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Ord Path Source #
Instance details Defined in CookieTray.Types Methods compare :: Path -> Path -> Ordering # (<) :: Path -> Path -> Bool # (<=) :: Path -> Path -> Bool # (>) :: Path -> Path -> Bool # (>=) :: Path -> Path -> Bool # max :: Path -> Path -> Path # min :: Path -> Path -> Path #

data Meta Source #

Constructors

Meta
Fields metaScope :: Scope metaSecurity :: Security

Instances

Instances details

Show Meta Source #
Instance details Defined in CookieTray.Types Methods showsPrec :: Int -> Meta -> ShowS # show :: Meta -> String # showList :: [Meta] -> ShowS #
Eq Meta Source #
Instance details Defined in CookieTray.Types Methods (==) :: Meta -> Meta -> Bool # (/=) :: Meta -> Meta -> Bool #
Ord Meta Source #
Instance details Defined in CookieTray.Types Methods compare :: Meta -> Meta -> Ordering # (<) :: Meta -> Meta -> Bool # (<=) :: Meta -> Meta -> Bool # (>) :: Meta -> Meta -> Bool # (>=) :: Meta -> Meta -> Bool # max :: Meta -> Meta -> Meta # min :: Meta -> Meta -> Meta #