Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Soup.Structs.Cookie

Contents

Exported types
Methods
Properties

Description

An HTTP cookie.

name and value will be set for all cookies. If the cookie is generated from a string that appears to have no name, then @name will be the empty string.

domain and path give the host or domain, and path within that host/domain, to restrict this cookie to. If domain starts with ".", that indicates a domain (which matches the string after the ".", or any hostname that hasdomain as a suffix). Otherwise, it is a hostname and must match exactly.

expires will be non-%NULL if the cookie uses either the original "expires" attribute, or the newer "max-age" attribute. Ifexpires is %NULL, it indicates that neither "expires" nor "max-age" was specified, and the cookie expires at the end of the session.

If @http_only is set, the cookie should not be exposed to untrusted code (eg, javascript), so as to minimize the danger posed by cross-site scripting attacks.

Synopsis

Exported types

newtype Cookie Source

Constructors

(ForeignPtr Cookie)

newZeroCookie :: MonadIO m => m Cookie Source

Construct a Cookie struct initialized to zero.

noCookie :: Maybe Cookie Source

Methods

cookieAppliesToUri

data CookieAppliesToUriMethodInfo Source

Instances

((~) (TYPE Lifted) signature (URI -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) CookieAppliesToUriMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieAppliesToUriMethodInfo Cookie -> signature -> s

cookieAppliesToUri :: MonadIO m => Cookie -> URI -> m Bool Source

cookieCopy

data CookieCopyMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Cookie), MonadIO m) => MethodInfo (TYPE Lifted) CookieCopyMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieCopyMethodInfo Cookie -> signature -> s

cookieCopy :: MonadIO m => Cookie -> m Cookie Source

cookieDomainMatches

data CookieDomainMatchesMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) CookieDomainMatchesMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieDomainMatchesMethodInfo Cookie -> signature -> s

cookieDomainMatches :: MonadIO m => Cookie -> Text -> m Bool Source

cookieEqual

data CookieEqualMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Cookie -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) CookieEqualMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieEqualMethodInfo Cookie -> signature -> s

cookieEqual :: MonadIO m => Cookie -> Cookie -> m Bool Source

cookieFree

data CookieFreeMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieFreeMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieFreeMethodInfo Cookie -> signature -> s

cookieFree :: MonadIO m => Cookie -> m () Source

cookieGetDomain

data CookieGetDomainMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) CookieGetDomainMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieGetDomainMethodInfo Cookie -> signature -> s

cookieGetDomain :: MonadIO m => Cookie -> m Text Source

cookieGetExpires

data CookieGetExpiresMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Date), MonadIO m) => MethodInfo (TYPE Lifted) CookieGetExpiresMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieGetExpiresMethodInfo Cookie -> signature -> s

cookieGetExpires :: MonadIO m => Cookie -> m Date Source

cookieGetHttpOnly

data CookieGetHttpOnlyMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) CookieGetHttpOnlyMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieGetHttpOnlyMethodInfo Cookie -> signature -> s

cookieGetHttpOnly :: MonadIO m => Cookie -> m Bool Source

cookieGetName

data CookieGetNameMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) CookieGetNameMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieGetNameMethodInfo Cookie -> signature -> s

cookieGetName :: MonadIO m => Cookie -> m Text Source

cookieGetPath

data CookieGetPathMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) CookieGetPathMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieGetPathMethodInfo Cookie -> signature -> s

cookieGetPath :: MonadIO m => Cookie -> m Text Source

cookieGetSecure

data CookieGetSecureMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) CookieGetSecureMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieGetSecureMethodInfo Cookie -> signature -> s

cookieGetSecure :: MonadIO m => Cookie -> m Bool Source

cookieGetValue

data CookieGetValueMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) CookieGetValueMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieGetValueMethodInfo Cookie -> signature -> s

cookieGetValue :: MonadIO m => Cookie -> m Text Source

cookieNew

cookieNew :: MonadIO m => Text -> Text -> Text -> Text -> Int32 -> m Cookie Source

cookieParse

cookieParse :: MonadIO m => Text -> URI -> m Cookie Source

cookieSetDomain

data CookieSetDomainMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieSetDomainMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieSetDomainMethodInfo Cookie -> signature -> s

cookieSetDomain :: MonadIO m => Cookie -> Text -> m () Source

cookieSetExpires

data CookieSetExpiresMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Date -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieSetExpiresMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieSetExpiresMethodInfo Cookie -> signature -> s

cookieSetExpires :: MonadIO m => Cookie -> Date -> m () Source

cookieSetHttpOnly

data CookieSetHttpOnlyMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Bool -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieSetHttpOnlyMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieSetHttpOnlyMethodInfo Cookie -> signature -> s

cookieSetHttpOnly :: MonadIO m => Cookie -> Bool -> m () Source

cookieSetMaxAge

data CookieSetMaxAgeMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Int32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieSetMaxAgeMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieSetMaxAgeMethodInfo Cookie -> signature -> s

cookieSetMaxAge :: MonadIO m => Cookie -> Int32 -> m () Source

cookieSetName

data CookieSetNameMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieSetNameMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieSetNameMethodInfo Cookie -> signature -> s

cookieSetName :: MonadIO m => Cookie -> Text -> m () Source

cookieSetPath

data CookieSetPathMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieSetPathMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieSetPathMethodInfo Cookie -> signature -> s

cookieSetPath :: MonadIO m => Cookie -> Text -> m () Source

cookieSetSecure

data CookieSetSecureMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Bool -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieSetSecureMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieSetSecureMethodInfo Cookie -> signature -> s

cookieSetSecure :: MonadIO m => Cookie -> Bool -> m () Source

cookieSetValue

data CookieSetValueMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) CookieSetValueMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieSetValueMethodInfo Cookie -> signature -> s

cookieSetValue :: MonadIO m => Cookie -> Text -> m () Source

cookieToCookieHeader

data CookieToCookieHeaderMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) CookieToCookieHeaderMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieToCookieHeaderMethodInfo Cookie -> signature -> s

cookieToCookieHeader :: MonadIO m => Cookie -> m Text Source

cookieToSetCookieHeader

data CookieToSetCookieHeaderMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) CookieToSetCookieHeaderMethodInfo Cookie signature Source
Methods overloadedMethod :: MethodProxy CookieToSetCookieHeaderMethodInfo Cookie -> signature -> s

cookieToSetCookieHeader :: MonadIO m => Cookie -> m Text Source

Properties

Domain

cookieReadDomain :: Cookie -> IO Text Source

Expires

cookieReadExpires :: Cookie -> IO Date Source

HttpOnly

cookieReadHttpOnly :: Cookie -> IO Bool Source

Name

cookieReadName :: Cookie -> IO Text Source

Path

cookieReadPath :: Cookie -> IO Text Source

Secure

cookieReadSecure :: Cookie -> IO Bool Source

Value

cookieReadValue :: Cookie -> IO Text Source