Safe Haskell	Safe-Inferred
Language	GHC2021

Prometheus.Servant.Internal

Synopsis

data Endpoint = Endpoint {
- ePathSegments :: [Text]
- eMethod :: Method
}
class HasEndpoint api where
- getEndpoint :: Proxy api -> Request -> Maybe Endpoint
- enumerateEndpoints :: Proxy api -> [Endpoint]

Documentation

data Endpoint Source #

Servant Endpoint.

Constructors

Endpoint
Fields ePathSegments :: [Text] Path segments of an endpoint. eMethod :: Method Endpoint method.

Instances

Instances details

Generic Endpoint Source #
Instance details Defined in Prometheus.Servant.Internal Associated Types type Rep Endpoint :: Type -> Type # Methods from :: Endpoint -> Rep Endpoint x # to :: Rep Endpoint x -> Endpoint #
Show Endpoint Source #
Instance details Defined in Prometheus.Servant.Internal Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #
Eq Endpoint Source #
Instance details Defined in Prometheus.Servant.Internal Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Hashable Endpoint Source #
Instance details Defined in Prometheus.Servant.Internal Methods hashWithSalt :: Int -> Endpoint -> Int # hash :: Endpoint -> Int #
type Rep Endpoint Source #
Instance details Defined in Prometheus.Servant.Internal type Rep Endpoint = D1 ('MetaData "Endpoint" "Prometheus.Servant.Internal" "servant-prometheus-1.2.0-inplace" 'False) (C1 ('MetaCons "Endpoint" 'PrefixI 'True) (S1 ('MetaSel ('Just "ePathSegments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "eMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Method)))

class HasEndpoint api where Source #

Specifies that api has servant Endpoint.

Methods

getEndpoint :: Proxy api -> Request -> Maybe Endpoint Source #

Tries to get Endpoint from Request for given api.

enumerateEndpoints :: Proxy api -> [Endpoint] Source #

Enumerates api to get list of Endpoints.

Instances

Instances details

HasEndpoint EmptyAPI Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy EmptyAPI -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy EmptyAPI -> [Endpoint] Source #
HasEndpoint Raw Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy Raw -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy Raw -> [Endpoint] Source #
HasEndpoint (ToServantApi sub) => HasEndpoint (NamedRoutes sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (NamedRoutes sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (NamedRoutes sub) -> [Endpoint] Source #
(HasEndpoint a, HasEndpoint b) => HasEndpoint (a :<\|> b :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (a :<\|> b) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (a :<\|> b) -> [Endpoint] Source #
ReflectMethod method => HasEndpoint (NoContentVerb method :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (NoContentVerb method) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (NoContentVerb method) -> [Endpoint] Source #
(KnownSymbol path, HasEndpoint sub) => HasEndpoint (path :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (path :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (path :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (HttpVersion :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (HttpVersion :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (HttpVersion :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (BasicAuth realm a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (BasicAuth realm a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (BasicAuth realm a :> sub) -> [Endpoint] Source #
(KnownSymbol capture, HasEndpoint sub) => HasEndpoint (Capture' mods capture a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (Capture' mods capture a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (Capture' mods capture a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (CaptureAll h a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (CaptureAll h a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (CaptureAll h a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (Description d :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (Description d :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (Description d :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (Summary d :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (Summary d :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (Summary d :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (AuthProtect a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (AuthProtect a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (AuthProtect a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (Fragment a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (Fragment a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (Fragment a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (Header' mods h a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (Header' mods h a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (Header' mods h a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (IsSecure :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (IsSecure :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (IsSecure :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (QueryFlag h :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (QueryFlag h :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (QueryFlag h :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (QueryParam' mods h a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (QueryParam' mods h a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (QueryParam' mods h a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (QueryParams h a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (QueryParams h a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (QueryParams h a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (RemoteHost :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (RemoteHost :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (RemoteHost :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (ReqBody' mods cts a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (ReqBody' mods cts a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (ReqBody' mods cts a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (StreamBody' mods framing cts a :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (StreamBody' mods framing cts a :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (StreamBody' mods framing cts a :> sub) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (Vault :> sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (Vault :> sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (Vault :> sub) -> [Endpoint] Source #
ReflectMethod method => HasEndpoint (UVerb method contentType as :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (UVerb method contentType as) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (UVerb method contentType as) -> [Endpoint] Source #
HasEndpoint sub => HasEndpoint (WithNamedContext x y sub :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (WithNamedContext x y sub) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (WithNamedContext x y sub) -> [Endpoint] Source #
ReflectMethod method => HasEndpoint (Verb method status cts a :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (Verb method status cts a) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (Verb method status cts a) -> [Endpoint] Source #
ReflectMethod method => HasEndpoint (Stream method status framing ct a :: Type) Source #
Instance details Defined in Prometheus.Servant.Internal Methods getEndpoint :: Proxy (Stream method status framing ct a) -> Request -> Maybe Endpoint Source # enumerateEndpoints :: Proxy (Stream method status framing ct a) -> [Endpoint] Source #