Ivory.Language.Ref

Documentation

type ConstRef = Pointer Valid Const

class IvoryRef (ref :: RefScope -> Area * -> *)

TODO remove class, leave function only

Minimal complete definition

unwrapRef

Instances

IvoryRef (Pointer Valid c)

Defined in Ivory.Language.Ref

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

Defined in Ivory.Language.Ref

IvoryStore Sint64

Defined in Ivory.Language.Ref

IvoryStore Sint32

Defined in Ivory.Language.Ref

IvoryStore Sint16

Defined in Ivory.Language.Ref

IvoryStore Sint8

Defined in Ivory.Language.Ref

IvoryStore Uint64

Defined in Ivory.Language.Ref

IvoryStore Uint32

Defined in Ivory.Language.Ref

IvoryStore Uint16

Defined in Ivory.Language.Ref

IvoryStore Uint8

Defined in Ivory.Language.Ref

IvoryStore IBool

Defined in Ivory.Language.Ref

IvoryStore IDouble

Defined in Ivory.Language.Float

IvoryStore IFloat

Defined in Ivory.Language.Float

ANat n => IvoryStore (Ix n)

Defined in Ivory.Language.Array

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

Defined in Ivory.Language.BitData.Bits

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

Defined in Ivory.Language.Ref

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 ()