Ivory.Language.Ref

Documentation

type ConstRef = Pointer Valid Const

class IvoryRef ref

TODO remove class, leave function only

Minimal complete definition

unwrapRef

Instances

IvoryRef (Pointer Valid c)

Methods

unwrapRef :: IvoryVar a => Pointer Valid c s (Stored * a) -> Expr

class IvoryVar a => IvoryStore a

Things that can be safely stored in references.

Instances

IvoryStore IChar

IvoryStore Sint64

IvoryStore Sint32

IvoryStore Sint16

IvoryStore Sint8

IvoryStore Uint64

IvoryStore Uint32

IvoryStore Uint16

IvoryStore Uint8

IvoryStore IBool

IvoryStore IDouble

IvoryStore IFloat

ANat n => IvoryStore (Ix n)

IvoryRep (BitRep n) => IvoryStore (Bits n)

(KnownConstancy c, IvoryArea a) => IvoryStore (Pointer Nullable c Global a)

type Ref = Pointer Valid Mutable

A non-null pointer to a memory area.

constRef :: IvoryArea area => Ref s area -> ConstRef s area

Turn a reference into a constant reference. TODO deprecate in favor of pointerCastToConst

deref :: forall eff ref s a. (IvoryStore a, IvoryVar a, IvoryVar (ref s (Stored a)), IvoryRef ref) => ref s (Stored a) -> Ivory eff a

Dereferenceing.

refCopy :: forall eff sTo ref sFrom a. (IvoryRef ref, IvoryVar (Ref sTo a), IvoryVar (ref sFrom a), IvoryArea a) => Ref sTo a -> ref sFrom a -> Ivory eff ()

Memory copy. Emits an assertion that the two references are unequal.

store :: forall eff s a. IvoryStore a => Ref s (Stored a) -> a -> Ivory eff ()