Network.Hawk.Internal.Client.Types

Consider this module to be internal, and don't import directly.

Documentation

data Credentials

ID and key used for encrypting Hawk Authorization header.

Constructors

Credentials

Fields

• ccId :: ClientId
• ccKey :: Key
• ccAlgorithm :: HawkAlgo

Instances

Show Credentials

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

Generic Credentials

Associated Types

type Rep Credentials :: * -> *

Methods

from :: Credentials -> Rep Credentials x

to :: Rep Credentials x -> Credentials

type Rep Credentials

type Rep Credentials = D1 (MetaData "Credentials" "Network.Hawk.Internal.Client.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "Credentials" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "ccId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientId)) ((:*:) (S1 (MetaSel (Just Symbol "ccKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)) (S1 (MetaSel (Just Symbol "ccAlgorithm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HawkAlgo)))))

data Header

The result of Hawk header generation.

Constructors

Header

Fields

• hdrField :: Authorization

  Value of Authorization header.

• hdrArtifacts :: HeaderArtifacts

  The parameters used to generate the header.

Instances

Show Header

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

Generic Header

Associated Types

type Rep Header :: * -> *

Methods

from :: Header -> Rep Header x

to :: Rep Header x -> Header

type Rep Header

type Rep Header = D1 (MetaData "Header" "Network.Hawk.Internal.Client.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "Header" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "hdrField") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Authorization)) (S1 (MetaSel (Just Symbol "hdrArtifacts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HeaderArtifacts))))

data Scheme

Constructors

HTTP

HTTPS

Instances

Eq Scheme

Methods

(==) :: Scheme -> Scheme -> Bool

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

Show Scheme

Methods

showsPrec :: Int -> Scheme -> ShowS

show :: Scheme -> String

showList :: [Scheme] -> ShowS

data SplitURL

Constructors

SplitURL

Fields

• urlScheme :: Scheme

  If URL uses the https scheme.

• urlHost :: ByteString

  Hostname or IP.

• urlPort :: Maybe Int

  Port, if given in URL.

• urlPath :: ByteString

  Everything after the hostname and port.

Instances

Show SplitURL

Methods

showsPrec :: Int -> SplitURL -> ShowS

show :: SplitURL -> String

showList :: [SplitURL] -> ShowS

Generic SplitURL

Associated Types

type Rep SplitURL :: * -> *

Methods

from :: SplitURL -> Rep SplitURL x

to :: Rep SplitURL x -> SplitURL

type Rep SplitURL

type Rep SplitURL = D1 (MetaData "SplitURL" "Network.Hawk.Internal.Client.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "SplitURL" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "urlScheme") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Scheme)) (S1 (MetaSel (Just Symbol "urlHost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString))) ((:*:) (S1 (MetaSel (Just Symbol "urlPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "urlPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))))

defaultPort :: Scheme -> Int

urlPort' :: SplitURL -> Int