Skip to content

HORIZON HASKELL Docs lts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulegrapesy-1.1.1Haskell2010

Network.GRPC.Common.Headers

Utilities for working with headers

1 class
6 values

Packagegrapesy-1.1.1
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceHeaders.hs

classclass Traversable h => HasRequiredHeaders (h :: (Type -> Type) -> Type) where

Required headers

Required headers are headers that grapesy needs to know in order to function. For example, we need to know which compression algorithm the peer is using for their messages to us.

Associated types

data family RequiredHeaders (h :: (Type -> Type) -> Type)

Methods

requiredHeaders :: h (Checked e) -> Either e (RequiredHeaders h)

Instances3HasRequiredHeaders

HasRequiredHeaders RequestHeaders_Defined in grapesy-1.1.1 · Network.GRPC.Common.Headers
HasRequiredHeaders ResponseHeaders_Defined in grapesy-1.1.1 · Network.GRPC.Common.Headers
HasRequiredHeaders TrailersOnly_Defined in grapesy-1.1.1 · Network.GRPC.Common.Headers

familydata family RequiredHeaders (h :: (Type -> Type) -> Type)

Instances3RequiredHeaders

data RequiredHeaders RequestHeaders_
- RequiredRequestHeadersrequiredRequestCompression :: Maybe CompressionIdrequiredRequestTimeout :: Maybe Timeout
Defined in grapesy-1.1.1 · Network.GRPC.Common.Headers
data RequiredHeaders ResponseHeaders_
- RequiredResponseHeadersrequiredResponseCompression :: Maybe CompressionId
Defined in grapesy-1.1.1 · Network.GRPC.Common.Headers
data RequiredHeaders TrailersOnly_
- NoRequiredTrailers
Defined in grapesy-1.1.1 · Network.GRPC.Common.Headers

constructorRequiredRequestHeaders

Fields

requiredRequestCompression :: Maybe CompressionId
requiredRequestTimeout :: Maybe Timeout

valuerequiredRequestCompression

:: RequiredHeaders RequestHeaders_
-> Maybe CompressionId

valuerequiredRequestTimeout :: RequiredHeaders RequestHeaders_ -> Maybe Timeout

constructorRequiredResponseHeaders

Fields

requiredResponseCompression :: Maybe CompressionId

valuerequiredResponseCompression

:: RequiredHeaders ResponseHeaders_
-> Maybe CompressionId

constructorNoRequiredTrailers

valueverifyRequired

:: HasRequiredHeaders h
=> h (Checked (InvalidHeaders HandledSynthesized))
-> Either (InvalidHeaders HandledSynthesized) (RequiredHeaders h)

Validate only the required headers

By default, we only check those headers grapesy needs to function.

valueverifyAll

:: HasRequiredHeaders h
=> h (Checked (InvalidHeaders HandledSynthesized))
-> Either (InvalidHeaders HandledSynthesized) (h Undecorated, RequiredHeaders h)

Validate all headers

Validate all headers; we do this only if connVerifyHeaders (on the client) or serverVerifyHeaders (on the server) is enabled.

valueverifyAllIf

:: HasRequiredHeaders h
=> Bool
-> h (Checked (InvalidHeaders HandledSynthesized))
-> Either (InvalidHeaders HandledSynthesized) (RequiredHeaders h)

Convenience wrapper, conditionally verifying all headers