| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Ecluse.Core.BuildIdentity
Description
The product identity shared by outbound registry requests and advisory feeds.
Synopsis
- data OperatorContact
- parseOperatorContact :: Text -> Either Text OperatorContact
- renderUserAgent :: Maybe OperatorContact -> ByteString
- identityManagerSettings :: ByteString -> ManagerSettings -> ManagerSettings
- productName :: Text
- productVersion :: Text
- userAgent :: ByteString
- identifyRequest :: Request -> Request
Documentation
data OperatorContact Source #
An operator contact that cannot alter the HTTP comment or inject a header.
Instances
| Show OperatorContact Source # | |
Defined in Ecluse.Core.BuildIdentity Methods showsPrec :: Int -> OperatorContact -> ShowS # show :: OperatorContact -> String # showList :: [OperatorContact] -> ShowS # | |
| Eq OperatorContact Source # | |
Defined in Ecluse.Core.BuildIdentity Methods (==) :: OperatorContact -> OperatorContact -> Bool # (/=) :: OperatorContact -> OperatorContact -> Bool # | |
parseOperatorContact :: Text -> Either Text OperatorContact Source #
Parse 1-256 printable ASCII characters, excluding comment delimiters and backslash.
renderUserAgent :: Maybe OperatorContact -> ByteString Source #
Render a validated contact into the outbound identity before requests start.
identityManagerSettings :: ByteString -> ManagerSettings -> ManagerSettings Source #
Chain request callbacks and replace only the default product identity or an absent identity.
productName :: Text Source #
The name Écluse identifies itself by to another service.
productVersion :: Text Source #
The running build's version, as the cabal file declares it.
userAgent :: ByteString Source #
The default identity, including the project's public URL.
identifyRequest :: Request -> Request Source #
Identify an outbound request unless the caller supplies its own identity.