Hercules.API.Name

Documentation

newtype Name (a :: k)

A slug. Display names are simply Text.

Constructors

Name

Fields

• nameText :: Text

Instances

FromJSON (Name a)

Defined in Hercules.API.Name

Methods

parseJSON :: Value -> Parser (Name a)

parseJSONList :: Value -> Parser [Name a]

ToJSON (Name a)

Defined in Hercules.API.Name

Methods

toJSON :: Name a -> Value

toEncoding :: Name a -> Encoding

toJSONList :: [Name a] -> Value

toEncodingList :: [Name a] -> Encoding

Generic (Name a)

Defined in Hercules.API.Name

Associated Types

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

Methods

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

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

Show (Name a)

Defined in Hercules.API.Name

Methods

showsPrec :: Int -> Name a -> ShowS

show :: Name a -> String

showList :: [Name a] -> ShowS

NFData (Name a)

Defined in Hercules.API.Name

Methods

rnf :: Name a -> ()

Eq (Name a)

Defined in Hercules.API.Name

Methods

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

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

Ord (Name a)

Defined in Hercules.API.Name

Methods

compare :: Name a -> Name a -> Ordering

(<) :: Name a -> Name a -> Bool

(<=) :: Name a -> Name a -> Bool

(>) :: Name a -> Name a -> Bool

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

max :: Name a -> Name a -> Name a

min :: Name a -> Name a -> Name a

Hashable (Name a)

Defined in Hercules.API.Name

Methods

hashWithSalt :: Int -> Name a -> Int

hash :: Name a -> Int

FromHttpApiData (Name a)

Defined in Hercules.API.Name

Methods

parseUrlPiece :: Text -> Either Text (Name a)

parseHeader :: ByteString -> Either Text (Name a)

parseQueryParam :: Text -> Either Text (Name a)

ToHttpApiData (Name a)

Defined in Hercules.API.Name

Methods

toUrlPiece :: Name a -> Text

toEncodedUrlPiece :: Name a -> Builder

toHeader :: Name a -> ByteString

toQueryParam :: Name a -> Text

ToParamSchema (Name a)

Defined in Hercules.API.Name

Methods

toParamSchema :: Proxy (Name a) -> Schema

(Typeable a, Typeable k) => ToSchema (Name a)

Defined in Hercules.API.Name

Methods

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

ToParamSchema (Name a)

Defined in Hercules.API.Name

Methods

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

ToSchema (Name a)

Defined in Hercules.API.Name

Methods

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

type Rep (Name a)

Defined in Hercules.API.Name

type Rep (Name a) = D1 ('MetaData "Name" "Hercules.API.Name" "hercules-ci-api-core-0.1.6.0-inplace" 'True) (C1 ('MetaCons "Name" 'PrefixI 'True) (S1 ('MetaSel ('Just "nameText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

uncheckedCast :: Name a -> Name b