Safe Haskell	Safe-Inferred
Language	GHC2021

Web.Hyperbole.Data.Encoded

Synopsis

newtype ConName = ConName {
- text :: Text
}
data Encoded = Encoded ConName [ParamValue]
encode :: ToEncoded a => a -> Text
decode :: FromEncoded a => Text -> Maybe a
decodeEither :: FromEncoded a => Text -> Either String a
encodedToText :: Encoded -> Text
encodedParseText :: Text -> Either String Encoded
genericToEncoded :: (Generic a, GToEncoded (Rep a)) => a -> Encoded
genericParseEncoded :: (Generic a, GFromEncoded (Rep a)) => Encoded -> Either String a
genericDecode :: (Generic a, GFromEncoded (Rep a)) => Text -> Maybe a
class ToEncoded a where
- toEncoded :: a -> Encoded
class FromEncoded a where
- parseEncoded :: Encoded -> Either String a
fromResult :: Result a -> Either String a
paramParser :: Parser ParamValue
decodeParam :: Text -> ParamValue
desanitizeParamText :: Text -> Text
encodeParam :: ParamValue -> Text
class GToEncoded f where
- gToEncoded :: f p -> Encoded
class GFromEncoded f where
- gParseEncoded :: Encoded -> Either String (f p, [ParamValue])

Documentation

newtype ConName Source #

Constructors

ConName
Fields text :: Text

Instances

Instances details

IsString ConName Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods fromString :: String -> ConName #
Monoid ConName Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods mempty :: ConName # mappend :: ConName -> ConName -> ConName # mconcat :: [ConName] -> ConName #
Semigroup ConName Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods (<>) :: ConName -> ConName -> ConName # sconcat :: NonEmpty ConName -> ConName # stimes :: Integral b => b -> ConName -> ConName #
Show ConName Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods showsPrec :: Int -> ConName -> ShowS # show :: ConName -> String # showList :: [ConName] -> ShowS #
Eq ConName Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods (==) :: ConName -> ConName -> Bool # (/=) :: ConName -> ConName -> Bool #
Ord ConName Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods compare :: ConName -> ConName -> Ordering # (<) :: ConName -> ConName -> Bool # (<=) :: ConName -> ConName -> Bool # (>) :: ConName -> ConName -> Bool # (>=) :: ConName -> ConName -> Bool # max :: ConName -> ConName -> ConName # min :: ConName -> ConName -> ConName #

data Encoded Source #

Pretty Human Readable top-levelencoding for ViewAction and ViewId For simple Sum and Product types it is equivalent to the Show/Read instance

MyConstructor 1 2 3

Constructors

Encoded ConName [ParamValue]

Instances

Instances details

Monoid Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods mempty :: Encoded # mappend :: Encoded -> Encoded -> Encoded # mconcat :: [Encoded] -> Encoded #
Semigroup Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods (<>) :: Encoded -> Encoded -> Encoded # sconcat :: NonEmpty Encoded -> Encoded # stimes :: Integral b => b -> Encoded -> Encoded #
Show Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods showsPrec :: Int -> Encoded -> ShowS # show :: Encoded -> String # showList :: [Encoded] -> ShowS #
Eq Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods (==) :: Encoded -> Encoded -> Bool # (/=) :: Encoded -> Encoded -> Bool #
Ord Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods compare :: Encoded -> Encoded -> Ordering # (<) :: Encoded -> Encoded -> Bool # (<=) :: Encoded -> Encoded -> Bool # (>) :: Encoded -> Encoded -> Bool # (>=) :: Encoded -> Encoded -> Bool # max :: Encoded -> Encoded -> Encoded # min :: Encoded -> Encoded -> Encoded #
FromEncoded Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods parseEncoded :: Encoded -> Either String Encoded Source #
ToEncoded Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods toEncoded :: Encoded -> Encoded Source #
FromJSON Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods parseJSON :: Value -> Parser Encoded # parseJSONList :: Value -> Parser [Encoded] # omittedField :: Maybe Encoded #
ToJSON Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods toJSON :: Encoded -> Value # toEncoding :: Encoded -> Encoding # toJSONList :: [Encoded] -> Value # toEncodingList :: [Encoded] -> Encoding # omitField :: Encoded -> Bool #

encode :: ToEncoded a => a -> Text Source #

decode :: FromEncoded a => Text -> Maybe a Source #

decodeEither :: FromEncoded a => Text -> Either String a Source #

encodedToText :: Encoded -> Text Source #

Basic Encoding

encodedParseText :: Text -> Either String Encoded Source #

genericToEncoded :: (Generic a, GToEncoded (Rep a)) => a -> Encoded Source #

genericParseEncoded :: (Generic a, GFromEncoded (Rep a)) => Encoded -> Either String a Source #

genericDecode :: (Generic a, GFromEncoded (Rep a)) => Text -> Maybe a Source #

class ToEncoded a where Source #

Custom Encoding for embedding into web documents. Noteably used for ViewId and ViewAction

Minimal complete definition

Nothing

Methods

toEncoded :: a -> Encoded Source #

default toEncoded :: (Generic a, GToEncoded (Rep a)) => a -> Encoded Source #

Instances

Instances details

ToEncoded Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods toEncoded :: Encoded -> Encoded Source #
ToEncoded ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods toEncoded :: ParamValue -> Encoded Source #
ToEncoded AuthFlow Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toEncoded :: AuthFlow -> Encoded Source #
ToEncoded Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toEncoded :: Authenticated -> Encoded Source #
ToEncoded ConcurrencyMode Source #
Instance details Defined in Web.Hyperbole.HyperView.Types Methods toEncoded :: ConcurrencyMode -> Encoded Source #
ToEncoded Text Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods toEncoded :: Text -> Encoded Source #
ToEncoded () Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods toEncoded :: () -> Encoded Source #
ToEncoded Int Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods toEncoded :: Int -> Encoded Source #
ToJSON a => ToEncoded (JSON a) Source #
Instance details Defined in Web.Hyperbole.Data.JSON Methods toEncoded :: JSON a -> Encoded Source #

class FromEncoded a where Source #

Custom Encoding for embedding into web documents. Noteably used for ViewId and ViewAction

Minimal complete definition

Nothing

Methods

parseEncoded :: Encoded -> Either String a Source #

default parseEncoded :: (Generic a, GFromEncoded (Rep a)) => Encoded -> Either String a Source #

Instances

Instances details

FromEncoded Encoded Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods parseEncoded :: Encoded -> Either String Encoded Source #
FromEncoded ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods parseEncoded :: Encoded -> Either String ParamValue Source #
FromEncoded AuthFlow Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseEncoded :: Encoded -> Either String AuthFlow Source #
FromEncoded Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseEncoded :: Encoded -> Either String Authenticated Source #
FromEncoded ConcurrencyMode Source #
Instance details Defined in Web.Hyperbole.HyperView.Types Methods parseEncoded :: Encoded -> Either String ConcurrencyMode Source #
FromEncoded Text Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods parseEncoded :: Encoded -> Either String Text Source #
FromEncoded () Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods parseEncoded :: Encoded -> Either String () Source #
FromEncoded Int Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods parseEncoded :: Encoded -> Either String Int Source #
FromJSON a => FromEncoded (JSON a) Source #
Instance details Defined in Web.Hyperbole.Data.JSON Methods parseEncoded :: Encoded -> Either String (JSON a) Source #

fromResult :: Result a -> Either String a Source #

paramParser :: Parser ParamValue Source #

decodeParam :: Text -> ParamValue Source #

desanitizeParamText :: Text -> Text Source #

encodeParam :: ParamValue -> Text Source #

class GToEncoded f where Source #

Methods

gToEncoded :: f p -> Encoded Source #

Instances

Instances details

GToEncoded (U1 :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gToEncoded :: forall (p :: k0). U1 p -> Encoded Source #
(GToEncoded f, GToEncoded g) => GToEncoded (f :*: g :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gToEncoded :: forall (p :: k0). (f :*: g) p -> Encoded Source #
(GToEncoded f, GToEncoded g) => GToEncoded (f :+: g :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gToEncoded :: forall (p :: k0). (f :+: g) p -> Encoded Source #
ToParam a => GToEncoded (K1 R a :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gToEncoded :: forall (p :: k0). K1 R a p -> Encoded Source #
(Constructor c, GToEncoded f) => GToEncoded (M1 C c f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gToEncoded :: forall (p :: k0). M1 C c f p -> Encoded Source #
GToEncoded f => GToEncoded (M1 D d f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gToEncoded :: forall (p :: k0). M1 D d f p -> Encoded Source #
GToEncoded f => GToEncoded (M1 S s f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gToEncoded :: forall (p :: k0). M1 S s f p -> Encoded Source #

class GFromEncoded f where Source #

Methods

gParseEncoded :: Encoded -> Either String (f p, [ParamValue]) Source #

Instances

Instances details

GFromEncoded (U1 :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gParseEncoded :: forall (p :: k0). Encoded -> Either String (U1 p, [ParamValue]) Source #
(GFromEncoded f, GFromEncoded g) => GFromEncoded (f :*: g :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gParseEncoded :: forall (p :: k0). Encoded -> Either String ((f :*: g) p, [ParamValue]) Source #
(GFromEncoded f, GFromEncoded g) => GFromEncoded (f :+: g :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gParseEncoded :: forall (p :: k0). Encoded -> Either String ((f :+: g) p, [ParamValue]) Source #
FromParam a => GFromEncoded (K1 R a :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gParseEncoded :: forall (p :: k0). Encoded -> Either String (K1 R a p, [ParamValue]) Source #
(Constructor c, GFromEncoded f) => GFromEncoded (M1 C c f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gParseEncoded :: forall (p :: k0). Encoded -> Either String (M1 C c f p, [ParamValue]) Source #
GFromEncoded f => GFromEncoded (M1 D d f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gParseEncoded :: forall (p :: k0). Encoded -> Either String (M1 D d f p, [ParamValue]) Source #
GFromEncoded f => GFromEncoded (M1 S s f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods gParseEncoded :: forall (p :: k0). Encoded -> Either String (M1 S s f p, [ParamValue]) Source #