Serokell.Data.Variant

Variant is a data type with dynamic structure. It's designed to be very generic, but also efficient. You can choose whatever data layout you want. This module re-exports modules relevant to this type.

Documentation

data Variant

Variant is intended to store arbitrary data in arbitrary format. You are free to choose data layout.

Constructors

VarNone

None, i. e. no value.

VarBool !Bool

Boolean value.

VarInt !Int64

Signed integer number.

VarUInt !Word64

Unsigned integer number.

VarFloat !Double

IEEE 754 double precision floating point number.

VarBytes !ByteString

Raw bytes.

VarString !Text

Unicode string.

VarList !VarList

List of Variants.

VarMap !VarMap

Map (with unique keys) from Variant to Variant.

Instances

IsList Variant

Defined in Serokell.Data.Variant.Variant

Associated Types

type Item Variant :: *

Methods

fromList :: [Item Variant] -> Variant

fromListN :: Int -> [Item Variant] -> Variant

toList :: Variant -> [Item Variant]

Eq Variant

Defined in Serokell.Data.Variant.Variant

Methods

(==) :: Variant -> Variant -> Bool

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

Show Variant

Defined in Serokell.Data.Variant.Variant

Methods

showsPrec :: Int -> Variant -> ShowS

show :: Variant -> String

showList :: [Variant] -> ShowS

IsString Variant

Defined in Serokell.Data.Variant.Variant

Methods

fromString :: String -> Variant

Generic Variant

Defined in Serokell.Data.Variant.Variant

Associated Types

type Rep Variant :: * -> *

Methods

from :: Variant -> Rep Variant x

to :: Rep Variant x -> Variant

Arbitrary Variant

Defined in Serokell.Arbitrary

Methods

arbitrary :: Gen Variant

shrink :: Variant -> [Variant]

Hashable Variant

Defined in Serokell.Data.Variant.Variant

Methods

hashWithSalt :: Int -> Variant -> Int

hash :: Variant -> Int

ToJSON Variant

Defined in Serokell.Data.Variant.Serialization

Methods

toJSON :: Variant -> Value

toEncoding :: Variant -> Encoding

toJSONList :: [Variant] -> Value

toEncodingList :: [Variant] -> Encoding

FromJSON Variant

Defined in Serokell.Data.Variant.Serialization

Methods

parseJSON :: Value -> Parser Variant

parseJSONList :: Value -> Parser [Variant]

NFData Variant

Defined in Serokell.Data.Variant.Variant

Methods

rnf :: Variant -> ()

Buildable Variant

Defined in Serokell.Data.Variant.Variant

Methods

build :: Variant -> Builder

Hashable (Vector Variant)

Defined in Serokell.Data.Variant.Variant

Methods

hashWithSalt :: Int -> Vector Variant -> Int

hash :: Vector Variant -> Int

type Rep Variant

Defined in Serokell.Data.Variant.Variant

type Rep Variant = D1 (MetaData "Variant" "Serokell.Data.Variant.Variant" "serokell-util-0.10.0-ABO96GElPTlE59q6YkXtOP" False) (((C1 (MetaCons "VarNone" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "VarBool" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))) :+: (C1 (MetaCons "VarInt" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int64)) :+: C1 (MetaCons "VarUInt" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word64)))) :+: ((C1 (MetaCons "VarFloat" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Double)) :+: C1 (MetaCons "VarBytes" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ByteString))) :+: (C1 (MetaCons "VarString" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: (C1 (MetaCons "VarList" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 VarList)) :+: C1 (MetaCons "VarMap" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 VarMap))))))

type Item Variant

Defined in Serokell.Data.Variant.Variant

type Item Variant = Variant

type VarList = Vector Variant

type VarMap = HashMap Variant Variant

none :: Variant

Shorter alias for VarNone.

varMap :: (Container t, Element t ~ (Variant, Variant)) => t -> Variant

Create VarMap from Foldable containing pairs of Variants. TODO: maybe use better approach like `a := b` to create KeyValuePair.

class ToVariant v where

Minimal complete definition

toVariant

Methods

toVariant :: v -> Variant

Instances

ToVariant Bool

Defined in Serokell.Data.Variant.Class

Methods

toVariant :: Bool -> Variant

ToVariant Double

Defined in Serokell.Data.Variant.Class

Methods

toVariant :: Double -> Variant

class FromVariant v where

Minimal complete definition

fromVariant

Methods

fromVariant :: MonadThrow m => Variant -> m v

Instances

FromVariant Double

Defined in Serokell.Data.Variant.Class

Methods

fromVariant :: MonadThrow m => Variant -> m Double