Data.Capnp.Untyped.Pure

This module provides an idiomatic Haskell interface for untyped capnp data, based on algebraic datatypes. It forgoes some of the benefits of the capnp wire format in favor of a more convienient API.

In addition to the algebraic data types themselves, this module also provides support for converting from the lower-level types in Data.Capnp.Untyped.

Documentation

type Cap = Word32

A capability in the wire format.

newtype Slice a

A one of a struct's sections (data or pointer).

This is just a newtype wrapper around ListOf (which is itself just Vector), but critically the notion of equality is different. Two slices are considered equal if all of their elements are equal, but If the slices are different lengths, missing elements are treated as having default values. Accordingly, equality is only defined if the element type is an instance of Default.

Constructors

Slice (ListOf a)

Instances

Functor Slice

Defined in Data.Capnp.Untyped.Pure

Methods

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

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

IsList (Slice a)

Defined in Data.Capnp.Untyped.Pure

Associated Types

type Item (Slice a) :: *

Methods

fromList :: [Item (Slice a)] -> Slice a

fromListN :: Int -> [Item (Slice a)] -> Slice a

toList :: Slice a -> [Item (Slice a)]

(Default a, Eq a) => Eq (Slice a)

Defined in Data.Capnp.Untyped.Pure

Methods

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

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

(Ord a, Default a) => Ord (Slice a)

Defined in Data.Capnp.Untyped.Pure

Methods

compare :: Slice a -> Slice a -> Ordering

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

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

(>) :: Slice a -> Slice a -> Bool

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

max :: Slice a -> Slice a -> Slice a

min :: Slice a -> Slice a -> Slice a

Read a => Read (Slice a)

Defined in Data.Capnp.Untyped.Pure

Methods

readsPrec :: Int -> ReadS (Slice a)

readList :: ReadS [Slice a]

readPrec :: ReadPrec (Slice a)

readListPrec :: ReadPrec [Slice a]

Show a => Show (Slice a)

Defined in Data.Capnp.Untyped.Pure

Methods

showsPrec :: Int -> Slice a -> ShowS

show :: Slice a -> String

showList :: [Slice a] -> ShowS

Generic (Slice a)

Defined in Data.Capnp.Untyped.Pure

Associated Types

type Rep (Slice a) :: * -> *

Methods

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

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

Default (Slice a)

Defined in Data.Capnp.Untyped.Pure

Methods

def :: Slice a

type Rep (Slice a)

Defined in Data.Capnp.Untyped.Pure

type Rep (Slice a) = D1 (MetaData "Slice" "Data.Capnp.Untyped.Pure" "capnp-0.1.0.0-IBFPKP2JelH5Ibzi4f2YyO" True) (C1 (MetaCons "Slice" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf a))))

type Item (Slice a)

Defined in Data.Capnp.Untyped.Pure

type Item (Slice a) = a

data PtrType

A capnproto pointer type.

Constructors

PtrStruct !Struct

PtrList !List

PtrCap !Cap

Instances

Eq PtrType

Defined in Data.Capnp.Untyped.Pure

Methods

(==) :: PtrType -> PtrType -> Bool

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

Read PtrType

Defined in Data.Capnp.Untyped.Pure

Methods

readsPrec :: Int -> ReadS PtrType

readList :: ReadS [PtrType]

readPrec :: ReadPrec PtrType

readListPrec :: ReadPrec [PtrType]

Show PtrType

Defined in Data.Capnp.Untyped.Pure

Methods

showsPrec :: Int -> PtrType -> ShowS

show :: PtrType -> String

showList :: [PtrType] -> ShowS

Generic PtrType

Defined in Data.Capnp.Untyped.Pure

Associated Types

type Rep PtrType :: * -> *

Methods

from :: PtrType -> Rep PtrType x

to :: Rep PtrType x -> PtrType

Cerialize s (Maybe PtrType)

Defined in Data.Capnp.Untyped.Pure

Methods

cerialize :: RWCtx m s => MutMsg s -> Maybe PtrType -> m (Cerial (MutMsg s) (Maybe PtrType))

Decerialize (Maybe PtrType)

Defined in Data.Capnp.Untyped.Pure

Associated Types

type Cerial msg (Maybe PtrType) :: *

Methods

decerialize :: ReadCtx m ConstMsg => Cerial ConstMsg (Maybe PtrType) -> m (Maybe PtrType)

type Rep PtrType

Defined in Data.Capnp.Untyped.Pure

type Rep PtrType = D1 (MetaData "PtrType" "Data.Capnp.Untyped.Pure" "capnp-0.1.0.0-IBFPKP2JelH5Ibzi4f2YyO" False) (C1 (MetaCons "PtrStruct" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Struct)) :+: (C1 (MetaCons "PtrList" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 List)) :+: C1 (MetaCons "PtrCap" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Cap))))

type Cerial msg (Maybe PtrType)

Defined in Data.Capnp.Untyped.Pure

type Cerial msg (Maybe PtrType) = Maybe (Ptr msg)

data Struct

A capnproto struct.

Constructors

Struct

Fields

• structData :: Slice Word64

  The struct's data section

• structPtrs :: Slice (Maybe PtrType)

  The struct's pointer section

Instances

Eq Struct

Defined in Data.Capnp.Untyped.Pure

Methods

(==) :: Struct -> Struct -> Bool

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

Read Struct

Defined in Data.Capnp.Untyped.Pure

Methods

readsPrec :: Int -> ReadS Struct

readList :: ReadS [Struct]

readPrec :: ReadPrec Struct

readListPrec :: ReadPrec [Struct]

Show Struct

Defined in Data.Capnp.Untyped.Pure

Methods

showsPrec :: Int -> Struct -> ShowS

show :: Struct -> String

showList :: [Struct] -> ShowS

Generic Struct

Defined in Data.Capnp.Untyped.Pure

Associated Types

type Rep Struct :: * -> *

Methods

from :: Struct -> Rep Struct x

to :: Rep Struct x -> Struct

Marshal Struct

Defined in Data.Capnp.Untyped.Pure

Methods

marshalInto :: RWCtx m s => Cerial (MutMsg s) Struct -> Struct -> m ()

Decerialize Struct

Defined in Data.Capnp.Untyped.Pure

Associated Types

type Cerial msg Struct :: *

Methods

decerialize :: ReadCtx m ConstMsg => Cerial ConstMsg Struct -> m Struct

Default Struct

Defined in Data.Capnp.Untyped.Pure

Methods

def :: Struct

Cerialize s Struct

Defined in Data.Capnp.Untyped.Pure

Methods

cerialize :: RWCtx m s => MutMsg s -> Struct -> m (Cerial (MutMsg s) Struct)

type Rep Struct

Defined in Data.Capnp.Untyped.Pure

type Rep Struct = D1 (MetaData "Struct" "Data.Capnp.Untyped.Pure" "capnp-0.1.0.0-IBFPKP2JelH5Ibzi4f2YyO" False) (C1 (MetaCons "Struct" PrefixI True) (S1 (MetaSel (Just "structData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Slice Word64)) :*: S1 (MetaSel (Just "structPtrs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Slice (Maybe PtrType)))))

type Cerial msg Struct

Defined in Data.Capnp.Untyped.Pure

type Cerial msg Struct = Struct msg

data List

An untyped list.

Constructors

List0 (ListOf ())

List1 (ListOf Bool)

List8 (ListOf Word8)

List16 (ListOf Word16)

List32 (ListOf Word32)

List64 (ListOf Word64)

ListPtr (ListOf (Maybe PtrType))

ListStruct (ListOf Struct)

Instances

Eq List

Defined in Data.Capnp.Untyped.Pure

Methods

(==) :: List -> List -> Bool

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

Read List

Defined in Data.Capnp.Untyped.Pure

Methods

readsPrec :: Int -> ReadS List

readList :: ReadS [List]

readPrec :: ReadPrec List

readListPrec :: ReadPrec [List]

Show List

Defined in Data.Capnp.Untyped.Pure

Methods

showsPrec :: Int -> List -> ShowS

show :: List -> String

showList :: [List] -> ShowS

Generic List

Defined in Data.Capnp.Untyped.Pure

Associated Types

type Rep List :: * -> *

Methods

from :: List -> Rep List x

to :: Rep List x -> List

Decerialize List

Defined in Data.Capnp.Untyped.Pure

Associated Types

type Cerial msg List :: *

Methods

decerialize :: ReadCtx m ConstMsg => Cerial ConstMsg List -> m List

Cerialize s List

Defined in Data.Capnp.Untyped.Pure

Methods

cerialize :: RWCtx m s => MutMsg s -> List -> m (Cerial (MutMsg s) List)

type Rep List

Defined in Data.Capnp.Untyped.Pure

type Rep List = D1 (MetaData "List" "Data.Capnp.Untyped.Pure" "capnp-0.1.0.0-IBFPKP2JelH5Ibzi4f2YyO" False) (((C1 (MetaCons "List0" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf ()))) :+: C1 (MetaCons "List1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf Bool)))) :+: (C1 (MetaCons "List8" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf Word8))) :+: C1 (MetaCons "List16" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf Word16))))) :+: ((C1 (MetaCons "List32" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf Word32))) :+: C1 (MetaCons "List64" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf Word64)))) :+: (C1 (MetaCons "ListPtr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf (Maybe PtrType)))) :+: C1 (MetaCons "ListStruct" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListOf Struct))))))

type Cerial msg List

Defined in Data.Capnp.Untyped.Pure

type Cerial msg List = List msg

type ListOf a = Vector a

Alias for Vector. Using this alias may make upgrading to future versions of the library easier, as we will likely switch to a more efficient representation at some point.

length :: ListOf a -> Int

Alias for vector's length.

sliceIndex :: Default a => Int -> Slice a -> a

Index into a slice, returning a default value if the the index is past the end of the array.

Orphan instances

(ListElem ConstMsg (Cerial ConstMsg a), Decerialize a) => Decerialize (ListOf a)

Associated Types

type Cerial msg (ListOf a) :: *

Methods

decerialize :: ReadCtx m ConstMsg => Cerial ConstMsg (ListOf a) -> m (ListOf a)