Data.Struct

Documentation

class Struct t where

An instance for Struct t is a witness to the machine-level equivalence of t and Object.

Minimal complete definition

Nothing

Methods

struct :: Dict (Coercible (t s) (Object s))

default struct :: Coercible (t s) (Object s) => Dict (Coercible (t s) (Object s))

Instances

Struct Object

Defined in Data.Struct.Internal

Methods

struct :: Dict (Coercible (Object s) (Object s))

Struct Label

Defined in Data.Struct.Internal.Label

Methods

struct :: Dict (Coercible (Label s) (Object s))

Struct (LinkCut a)

Defined in Data.Struct.Internal.LinkCut

Methods

struct :: Dict (Coercible (LinkCut a s) (Object s))

Struct (Order a)

Defined in Data.Struct.Internal.Order

Methods

struct :: Dict (Coercible (Order a s) (Object s))

data Object s

Instances

Struct Object

Defined in Data.Struct.Internal

Methods

struct :: Dict (Coercible (Object s) (Object s))

Eq (Object s)

Defined in Data.Struct.Internal

Methods

(==) :: Object s -> Object s -> Bool

(/=) :: Object s -> Object s -> Bool

destruct :: Struct t => t s -> SmallMutableArray# s Any

construct :: Struct t => SmallMutableArray# s Any -> t s

eqStruct :: Struct t => t s -> t s -> Bool

alloc :: (PrimMonad m, Struct t) => Int -> m (t (PrimState m))

Allocate a structure made out of n slots. Initialize the structure before proceeding!

Nil

pattern Nil :: Struct t => t s

Truly imperative.

isNil :: Struct t => t s -> Bool

Predicate to check if a struct is Nil.

>>> isNil (Nil :: Object (PrimState IO))
True
>>> o <- alloc 1 :: IO (Object (PrimState IO))
>>> isNil o
False

data NullPointerException

Constructors

NullPointerException

Instances

Exception NullPointerException

Defined in Data.Struct.Internal

Methods

toException :: NullPointerException -> SomeException

fromException :: SomeException -> Maybe NullPointerException

displayException :: NullPointerException -> String

Show NullPointerException

Defined in Data.Struct.Internal

Methods

showsPrec :: Int -> NullPointerException -> ShowS

show :: NullPointerException -> String

showList :: [NullPointerException] -> ShowS

Slots and Fields

data Slot x y

A Slot is a reference to another unboxed mutable object.

Instances

Precomposable (Slot :: k1 -> k2 -> Type)

Defined in Data.Struct.Internal

Methods

(#) :: forall (x :: k) (y :: k) (z :: k10). Slot x y -> Slot y z -> Slot x z

slot

Arguments

:: Int

slot

-> Slot s t

The Slot at the given position in a Struct

get :: (PrimMonad m, Struct x, Struct y) => Slot x y -> x (PrimState m) -> m (y (PrimState m))

Get the value from a Slot

set :: (PrimMonad m, Struct x, Struct y) => Slot x y -> x (PrimState m) -> y (PrimState m) -> m ()

Set the value of a Slot

data Field x a

A Field is a reference from a struct to a normal Haskell data type.

Instances

Precomposable (Field :: k -> Type -> Type)

Defined in Data.Struct.Internal

Methods

(#) :: forall (x :: k0) (y :: k0) (z :: k1). Slot x y -> Field y z -> Field x z

field

Arguments

:: Int

slot

-> Field s a

Store the reference to the Haskell data type in a normal field

unboxedField

Arguments

:: Prim a

=> Int

slot

-> Int

argument

-> Field s a

Store the reference in the nth slot in the nth argument, treated as a MutableByteArray

getField :: (PrimMonad m, Struct x) => Field x a -> x (PrimState m) -> m a

Get the value of a field in a struct

setField :: (PrimMonad m, Struct x) => Field x a -> x (PrimState m) -> a -> m ()

Set the value of a field in a struct

modifyField :: (Struct x, PrimMonad m) => Field x a -> x (PrimState m) -> (a -> a) -> m ()

modifyField' :: (Struct x, PrimMonad m) => Field x a -> x (PrimState m) -> (a -> a) -> m ()

class Precomposable t where

We can compose slots to get a nested slot or field accessor

Methods

(#) :: Slot x y -> t y z -> t x z

Instances

Precomposable (Field :: k -> Type -> Type)

Defined in Data.Struct.Internal

Methods

(#) :: forall (x :: k0) (y :: k0) (z :: k1). Slot x y -> Field y z -> Field x z

Precomposable (Slot :: k1 -> k2 -> Type)

Defined in Data.Struct.Internal

Methods

(#) :: forall (x :: k) (y :: k) (z :: k10). Slot x y -> Slot y z -> Slot x z