Argo

Documentation

data Value where

A JSON (JavaScript Object Notation) value, as described by RFC 8259. https://datatracker.ietf.org/doc/html/rfc8259

Bundled Patterns

pattern Null :: Value

pattern Boolean :: Bool -> Value

pattern Number :: Integer -> Integer -> Value

pattern String :: Text -> Value

pattern Array :: Array -> Value

pattern Object :: Object -> Value

Instances

Eq Value

Defined in Argo.Json.Value

Methods

(==) :: Value -> Value -> Bool

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

Show Value

Defined in Argo.Json.Value

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

Generic Value

Defined in Argo.Json.Value

Associated Types

type Rep Value :: Type -> Type

Methods

from :: Value -> Rep Value x

to :: Rep Value x -> Value

NFData Value

Defined in Argo.Json.Value

Methods

rnf :: Value -> ()

FromValue Value

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Value

ToValue Value

Defined in Argo.Class.ToValue

Methods

toValue :: Value -> Value

Lift Value

Defined in Argo.Json.Value

Methods

lift :: Value -> Q Exp

liftTyped :: Value -> Q (TExp Value)

type Rep Value

Defined in Argo.Json.Value

type Rep Value = D1 ('MetaData "Value" "Argo.Json.Value" "argo-0.2021.11.7-9j0sCBbyLtLBlzqpZ8NEi5" 'False) ((C1 ('MetaCons "Null" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Null)) :+: (C1 ('MetaCons "Boolean" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Boolean)) :+: C1 ('MetaCons "Number" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Number)))) :+: (C1 ('MetaCons "String" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: (C1 ('MetaCons "Array" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ArrayOf Value))) :+: C1 ('MetaCons "Object" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ObjectOf Value))))))

type Array = [Value]

data Name

Instances

Eq Name

Defined in Argo.Json.Name

Methods

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

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

Show Name

Defined in Argo.Json.Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

Generic Name

Defined in Argo.Json.Name

Associated Types

type Rep Name :: Type -> Type

Methods

from :: Name -> Rep Name x

to :: Rep Name x -> Name

NFData Name

Defined in Argo.Json.Name

Methods

rnf :: Name -> ()

Lift Name

Defined in Argo.Json.Name

Methods

lift :: Name -> Q Exp

liftTyped :: Name -> Q (TExp Name)

type Rep Name

Defined in Argo.Json.Name

type Rep Name = D1 ('MetaData "Name" "Argo.Json.Name" "argo-0.2021.11.7-9j0sCBbyLtLBlzqpZ8NEi5" 'True) (C1 ('MetaCons "Name" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

pattern Name :: Text -> Name

type Member = MemberOf Value

pattern Member :: Name -> Value -> Member

type Object = [Member]

encode :: ToValue a => a -> Builder

encodeWith :: ToValue a => Indent -> a -> Builder

data Indent

Constructors

Spaces Int

Tab

Instances

Eq Indent

Defined in Argo.Encoder

Methods

(==) :: Indent -> Indent -> Bool

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

Show Indent

Defined in Argo.Encoder

Methods

showsPrec :: Int -> Indent -> ShowS

show :: Indent -> String

showList :: [Indent] -> ShowS

decode :: FromValue a => ByteString -> Result a

class FromValue a where

Methods

fromValue :: Value -> Result a

Instances

FromValue Bool

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Bool

FromValue Char

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Char

FromValue Double

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Double

FromValue Float

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Float

FromValue Int

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Int

FromValue Int8

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Int8

FromValue Int16

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Int16

FromValue Int32

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Int32

FromValue Int64

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Int64

FromValue Integer

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Integer

FromValue Word

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Word

FromValue Word8

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Word8

FromValue Word16

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Word16

FromValue Word32

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Word32

FromValue Word64

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Word64

FromValue ()

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result ()

FromValue String

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result String

FromValue Text

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Text

FromValue Value

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Value

FromValue Pointer

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Pointer

FromValue a => FromValue [a]

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result [a]

FromValue a => FromValue (Maybe a)

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result (Maybe a)

FromValue a => FromValue (NonEmpty a)

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result (NonEmpty a)

(FromValue a, FromValue b) => FromValue (a, b)

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result (a, b)

FromValue a => FromValue (Map Text a)

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result (Map Text a)

class ToValue a where

Methods

toValue :: a -> Value

Instances

ToValue Bool

Defined in Argo.Class.ToValue

Methods

toValue :: Bool -> Value

ToValue Char

Defined in Argo.Class.ToValue

Methods

toValue :: Char -> Value

ToValue Double

Defined in Argo.Class.ToValue

Methods

toValue :: Double -> Value

ToValue Float

Defined in Argo.Class.ToValue

Methods

toValue :: Float -> Value

ToValue Int

Defined in Argo.Class.ToValue

Methods

toValue :: Int -> Value

ToValue Int8

Defined in Argo.Class.ToValue

Methods

toValue :: Int8 -> Value

ToValue Int16

Defined in Argo.Class.ToValue

Methods

toValue :: Int16 -> Value

ToValue Int32

Defined in Argo.Class.ToValue

Methods

toValue :: Int32 -> Value

ToValue Int64

Defined in Argo.Class.ToValue

Methods

toValue :: Int64 -> Value

ToValue Integer

Defined in Argo.Class.ToValue

Methods

toValue :: Integer -> Value

ToValue Word

Defined in Argo.Class.ToValue

Methods

toValue :: Word -> Value

ToValue Word8

Defined in Argo.Class.ToValue

Methods

toValue :: Word8 -> Value

ToValue Word16

Defined in Argo.Class.ToValue

Methods

toValue :: Word16 -> Value

ToValue Word32

Defined in Argo.Class.ToValue

Methods

toValue :: Word32 -> Value

ToValue Word64

Defined in Argo.Class.ToValue

Methods

toValue :: Word64 -> Value

ToValue ()

Defined in Argo.Class.ToValue

Methods

toValue :: () -> Value

ToValue String

Defined in Argo.Class.ToValue

Methods

toValue :: String -> Value

ToValue Text

Defined in Argo.Class.ToValue

Methods

toValue :: Text -> Value

ToValue Value

Defined in Argo.Class.ToValue

Methods

toValue :: Value -> Value

ToValue Pointer

Defined in Argo.Class.ToValue

Methods

toValue :: Pointer -> Value

ToValue a => ToValue [a]

Defined in Argo.Class.ToValue

Methods

toValue :: [a] -> Value

ToValue a => ToValue (Maybe a)

Defined in Argo.Class.ToValue

Methods

toValue :: Maybe a -> Value

ToValue a => ToValue (NonEmpty a)

Defined in Argo.Class.ToValue

Methods

toValue :: NonEmpty a -> Value

(ToValue a, ToValue b) => ToValue (a, b)

Defined in Argo.Class.ToValue

Methods

toValue :: (a, b) -> Value

ToValue a => ToValue (Map Text a)

Defined in Argo.Class.ToValue

Methods

toValue :: Map Text a -> Value

value :: QuasiQuoter

pointer :: QuasiQuoter

data Result a

Constructors

Failure String

Success a

Instances

Monad Result

Defined in Argo.Result

Methods

(>>=) :: Result a -> (a -> Result b) -> Result b

(>>) :: Result a -> Result b -> Result b

return :: a -> Result a

Functor Result

Defined in Argo.Result

Methods

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

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

MonadFail Result

Defined in Argo.Result

Methods

fail :: String -> Result a

Applicative Result

Defined in Argo.Result

Methods

pure :: a -> Result a

(<*>) :: Result (a -> b) -> Result a -> Result b

liftA2 :: (a -> b -> c) -> Result a -> Result b -> Result c

(*>) :: Result a -> Result b -> Result b

(<*) :: Result a -> Result b -> Result a

Alternative Result

Defined in Argo.Result

Methods

empty :: Result a

(<|>) :: Result a -> Result a -> Result a

some :: Result a -> Result [a]

many :: Result a -> Result [a]

Eq a => Eq (Result a)

Defined in Argo.Result

Methods

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

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

Show a => Show (Result a)

Defined in Argo.Result

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

Generic (Result a)

Defined in Argo.Result

Associated Types

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

Methods

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

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

NFData a => NFData (Result a)

Defined in Argo.Result

Methods

rnf :: Result a -> ()

type Rep (Result a)

Defined in Argo.Result

type Rep (Result a) = D1 ('MetaData "Result" "Argo.Result" "argo-0.2021.11.7-9j0sCBbyLtLBlzqpZ8NEi5" 'False) (C1 ('MetaCons "Failure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "Success" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

newtype Pointer

A JSON pointer, as described by RFC 6901. https://datatracker.ietf.org/doc/html/rfc6901

Constructors

Pointer [Token]

Instances

Eq Pointer

Defined in Argo.Pointer.Pointer

Methods

(==) :: Pointer -> Pointer -> Bool

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

Show Pointer

Defined in Argo.Pointer.Pointer

Methods

showsPrec :: Int -> Pointer -> ShowS

show :: Pointer -> String

showList :: [Pointer] -> ShowS

Generic Pointer

Defined in Argo.Pointer.Pointer

Associated Types

type Rep Pointer :: Type -> Type

Methods

from :: Pointer -> Rep Pointer x

to :: Rep Pointer x -> Pointer

NFData Pointer

Defined in Argo.Pointer.Pointer

Methods

rnf :: Pointer -> ()

FromValue Pointer

Defined in Argo.Class.FromValue

Methods

fromValue :: Value -> Result Pointer

ToValue Pointer

Defined in Argo.Class.ToValue

Methods

toValue :: Pointer -> Value

Lift Pointer

Defined in Argo.Pointer.Pointer

Methods

lift :: Pointer -> Q Exp

liftTyped :: Pointer -> Q (TExp Pointer)

type Rep Pointer

Defined in Argo.Pointer.Pointer

type Rep Pointer = D1 ('MetaData "Pointer" "Argo.Pointer.Pointer" "argo-0.2021.11.7-9j0sCBbyLtLBlzqpZ8NEi5" 'True) (C1 ('MetaCons "Pointer" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Token])))

newtype Token

Constructors

Token Text

Instances

Eq Token

Defined in Argo.Pointer.Token

Methods

(==) :: Token -> Token -> Bool

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

Show Token

Defined in Argo.Pointer.Token

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

Generic Token

Defined in Argo.Pointer.Token

Associated Types

type Rep Token :: Type -> Type

Methods

from :: Token -> Rep Token x

to :: Rep Token x -> Token

NFData Token

Defined in Argo.Pointer.Token

Methods

rnf :: Token -> ()

Lift Token

Defined in Argo.Pointer.Token

Methods

lift :: Token -> Q Exp

liftTyped :: Token -> Q (TExp Token)

type Rep Token

Defined in Argo.Pointer.Token

type Rep Token = D1 ('MetaData "Token" "Argo.Pointer.Token" "argo-0.2021.11.7-9j0sCBbyLtLBlzqpZ8NEi5" 'True) (C1 ('MetaCons "Token" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

evaluate :: Pointer -> Value -> Result Value

encodePointer :: Pointer -> Builder

decodePointer :: ByteString -> Result Pointer