Hercules.API.Attribute

Documentation

data AttributeType

Constructors

Regular

MustFail

MayFail

DependenciesOnly

Effect

Instances

FromJSON AttributeType

Defined in Hercules.API.Attribute

Methods

parseJSON :: Value -> Parser AttributeType

parseJSONList :: Value -> Parser [AttributeType]

ToJSON AttributeType

Defined in Hercules.API.Attribute

Methods

toJSON :: AttributeType -> Value

toEncoding :: AttributeType -> Encoding

toJSONList :: [AttributeType] -> Value

toEncodingList :: [AttributeType] -> Encoding

Generic AttributeType

Defined in Hercules.API.Attribute

Associated Types

type Rep AttributeType :: Type -> Type

Methods

from :: AttributeType -> Rep AttributeType x

to :: Rep AttributeType x -> AttributeType

Show AttributeType

Defined in Hercules.API.Attribute

Methods

showsPrec :: Int -> AttributeType -> ShowS

show :: AttributeType -> String

showList :: [AttributeType] -> ShowS

NFData AttributeType

Defined in Hercules.API.Attribute

Methods

rnf :: AttributeType -> ()

Eq AttributeType

Defined in Hercules.API.Attribute

Methods

(==) :: AttributeType -> AttributeType -> Bool

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

Ord AttributeType

An arbitrary ordering

Defined in Hercules.API.Attribute

Methods

compare :: AttributeType -> AttributeType -> Ordering

(<) :: AttributeType -> AttributeType -> Bool

(<=) :: AttributeType -> AttributeType -> Bool

(>) :: AttributeType -> AttributeType -> Bool

(>=) :: AttributeType -> AttributeType -> Bool

max :: AttributeType -> AttributeType -> AttributeType

min :: AttributeType -> AttributeType -> AttributeType

ToSchema AttributeType

Defined in Hercules.API.Attribute

Methods

declareNamedSchema :: Proxy AttributeType -> Declare (Definitions Schema) NamedSchema

ToSchema AttributeType

Defined in Hercules.API.Attribute

Methods

declareNamedSchema :: Proxy AttributeType -> Declare (Definitions Schema) NamedSchema

type Rep AttributeType

Defined in Hercules.API.Attribute

type Rep AttributeType = D1 ('MetaData "AttributeType" "Hercules.API.Attribute" "hercules-ci-api-0.8.4.0-inplace" 'False) ((C1 ('MetaCons "Regular" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MustFail" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MayFail" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DependenciesOnly" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Effect" 'PrefixI 'False) (U1 :: Type -> Type))))

data Attribute a

Constructors

Attribute

Fields

• path :: [Text]
• value :: a
• typ :: AttributeType

Instances

Foldable Attribute

Defined in Hercules.API.Attribute

Methods

fold :: Monoid m => Attribute m -> m

foldMap :: Monoid m => (a -> m) -> Attribute a -> m

foldMap' :: Monoid m => (a -> m) -> Attribute a -> m

foldr :: (a -> b -> b) -> b -> Attribute a -> b

foldr' :: (a -> b -> b) -> b -> Attribute a -> b

foldl :: (b -> a -> b) -> b -> Attribute a -> b

foldl' :: (b -> a -> b) -> b -> Attribute a -> b

foldr1 :: (a -> a -> a) -> Attribute a -> a

foldl1 :: (a -> a -> a) -> Attribute a -> a

toList :: Attribute a -> [a]

null :: Attribute a -> Bool

length :: Attribute a -> Int

elem :: Eq a => a -> Attribute a -> Bool

maximum :: Ord a => Attribute a -> a

minimum :: Ord a => Attribute a -> a

sum :: Num a => Attribute a -> a

product :: Num a => Attribute a -> a

Traversable Attribute

Defined in Hercules.API.Attribute

Methods

traverse :: Applicative f => (a -> f b) -> Attribute a -> f (Attribute b)

sequenceA :: Applicative f => Attribute (f a) -> f (Attribute a)

mapM :: Monad m => (a -> m b) -> Attribute a -> m (Attribute b)

sequence :: Monad m => Attribute (m a) -> m (Attribute a)

Functor Attribute

Defined in Hercules.API.Attribute

Methods

fmap :: (a -> b) -> Attribute a -> Attribute b

(<$) :: a -> Attribute b -> Attribute a

FromJSON a => FromJSON (Attribute a)

Defined in Hercules.API.Attribute

Methods

parseJSON :: Value -> Parser (Attribute a)

parseJSONList :: Value -> Parser [Attribute a]

ToJSON a => ToJSON (Attribute a)

Defined in Hercules.API.Attribute

Methods

toJSON :: Attribute a -> Value

toEncoding :: Attribute a -> Encoding

toJSONList :: [Attribute a] -> Value

toEncodingList :: [Attribute a] -> Encoding

Generic (Attribute a)

Defined in Hercules.API.Attribute

Associated Types

type Rep (Attribute a) :: Type -> Type

Methods

from :: Attribute a -> Rep (Attribute a) x

to :: Rep (Attribute a) x -> Attribute a

Show a => Show (Attribute a)

Defined in Hercules.API.Attribute

Methods

showsPrec :: Int -> Attribute a -> ShowS

show :: Attribute a -> String

showList :: [Attribute a] -> ShowS

NFData a => NFData (Attribute a)

Defined in Hercules.API.Attribute

Methods

rnf :: Attribute a -> ()

Eq a => Eq (Attribute a)

Defined in Hercules.API.Attribute

Methods

(==) :: Attribute a -> Attribute a -> Bool

(/=) :: Attribute a -> Attribute a -> Bool

ToSchema a => ToSchema (Attribute a)

Defined in Hercules.API.Attribute

Methods

declareNamedSchema :: Proxy (Attribute a) -> Declare (Definitions Schema) NamedSchema

ToSchema a => ToSchema (Attribute a)

Defined in Hercules.API.Attribute

Methods

declareNamedSchema :: Proxy (Attribute a) -> Declare (Definitions Schema) NamedSchema

type Rep (Attribute a)

Defined in Hercules.API.Attribute

type Rep (Attribute a) = D1 ('MetaData "Attribute" "Hercules.API.Attribute" "hercules-ci-api-0.8.4.0-inplace" 'False) (C1 ('MetaCons "Attribute" 'PrefixI 'True) (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "typ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AttributeType))))

newtype AttributePath

Constructors

AttributePath

Fields

• fromAttributePath :: [Text]

Instances

Generic AttributePath

Defined in Hercules.API.Attribute

Associated Types

type Rep AttributePath :: Type -> Type

Methods

from :: AttributePath -> Rep AttributePath x

to :: Rep AttributePath x -> AttributePath

NFData AttributePath

Defined in Hercules.API.Attribute

Methods

rnf :: AttributePath -> ()

Eq AttributePath

Defined in Hercules.API.Attribute

Methods

(==) :: AttributePath -> AttributePath -> Bool

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

FromHttpApiData AttributePath

Defined in Hercules.API.Attribute

Methods

parseUrlPiece :: Text -> Either Text AttributePath

parseHeader :: ByteString -> Either Text AttributePath

parseQueryParam :: Text -> Either Text AttributePath

ToHttpApiData AttributePath

Defined in Hercules.API.Attribute

Methods

toUrlPiece :: AttributePath -> Text

toEncodedUrlPiece :: AttributePath -> Builder

toHeader :: AttributePath -> ByteString

toQueryParam :: AttributePath -> Text

toEncodedQueryParam :: AttributePath -> Builder

ToParamSchema AttributePath

Defined in Hercules.API.Attribute

Methods

toParamSchema :: Proxy AttributePath -> Schema

ToParamSchema AttributePath

Defined in Hercules.API.Attribute

Methods

toParamSchema :: forall (t :: SwaggerKind Type). Proxy AttributePath -> ParamSchema t

type Rep AttributePath

Defined in Hercules.API.Attribute

type Rep AttributePath = D1 ('MetaData "AttributePath" "Hercules.API.Attribute" "hercules-ci-api-0.8.4.0-inplace" 'True) (C1 ('MetaCons "AttributePath" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAttributePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

attributePathFromString :: Text -> [Text]

attributePathToString :: [Text] -> Text