Idris2Doc : Data.C.Struct

Data.C.Struct

(source)

Definitions

prim__malloc : Bits32 -> AnyPtr
prim__calloc : Bits32 -> Bits32 -> AnyPtr
prim__free : AnyPtr -> PrimIO ()
interface WrappedPtr : Type -> Type
Parameters: a
Methods:
wrap : AnyPtr -> a
unwrap : a -> AnyPtr

Implementation: 
Struct f => WrappedPtr (f s)
wrap : WrappedPtr a => AnyPtr -> a
Totality: total
Visibility: public export
unwrap : WrappedPtr a => a -> AnyPtr
Totality: total
Visibility: public export
interface Struct : (Type -> Type) -> Type
  Interface for wrappers around `struct` pointers.

Functions `wrap` and `unwrap` are used to convert from and
to the underlying pointer.

Parameters: f
Methods:
swrap : AnyPtr -> f s
sunwrap : f s -> AnyPtr
swrap : Struct f => AnyPtr -> f s
Totality: total
Visibility: public export
sunwrap : Struct f => f s -> AnyPtr
Totality: total
Visibility: public export
freeStruct1 : Struct f => f s -> F1' s
  Frees the memory allocated for a `struct`

Totality: total
Visibility: export
allocStruct1 : (0 f : (Type -> Type)) -> SizeOf (f s) => Struct f => F1 s (f s)
  Allocates memory for a single `struct`

Totality: total
Visibility: export
callocStruct1 : (0 f : (Type -> Type)) -> SizeOf (f s) => Struct f => F1 s (f s)
  Allocates memory for a single `struct`

Totality: total
Visibility: export
freeStruct : Lift1 s m => Struct f => f s -> m ()
  Frees the memory allocated for a `struct`

Totality: total
Visibility: export
allocStruct : Lift1 s m => (0 f : (Type -> Type)) -> SizeOf (f s) => Struct f => m (f s)
  Allocates memory for a single `struct` with all bits set to 0.

Totality: total
Visibility: export
callocStruct : Lift1 s m => (0 f : (Type -> Type)) -> SizeOf (f s) => Struct f => m (f s)
  Allocates memory for a single `struct` with all bits set to 0.

Totality: total
Visibility: export