Module swim_mem::resident

Memory usage model.

Residents

A memory Resident abstracts over the usage of a memory Lease, which itself abstracts over the allocation and ownership semantics of a raw, unsized memory block.

The most commonly used Resident implementations include:

• Box: stores a single value in a raw memory block.
• Buf: stores a resizeable array of values in a raw memory block.
• String: stores a resizeable Unicode string in a raw memory block.

Lease implementations that compose a Resident include:

• Raw: the exclusive owner of a relocatable, raw memory block, with resident metadata stored with the pointer.
• Ptr: the exclusive owner of a relocatable, raw memory block, with resident metadata stored within the allocation.
• Mut: a mutably dereferenceable strong owner of an unrelocatable, reference counted memory block.
• Ref: an immutably dereferenceable strong owner of an unrelocatable, reference counted memory block.
• Hard: an undereferenceable strong owner of a relocatable, reference counted memory block.
• Soft: an undereferenceable weak owner of a relocatable, reference counted memory block.

Structs

Box	A single value, residing in a memory Lease. A Box is a Resident typeclass; it doesn't store any data in its internal structure. Rather, Box implements an access pattern for memory blocks managed by a Lease. A composing Lease type defines the memory allocation and ownership semantics of the composed Box type.
Buf	A resizeable array of values, residing in a memory Lease. A Buf is a Resident typeclass; it doesn't store any data in its internal structure. Rather, Buf implements an access pattern for memory blocks managed by a Lease. A composing Lease type defines the memory allocation and ownership semantics of the composed Buf type.
BufDrain
BufHeader	The Meta structure associated with every Lease in which a Buf resides.
BufIter
BufLease
String	A resizeable array of Unicode code points, residing in a memory Lease. A String is a Resident typeclass; it doesn't store any data in its internal structure. Rather, String implements an access pattern for memory blocks managed by a Lease. A composing Lease type defines the memory allocation and ownership semantics of the composed String type.
StringLease

Traits

Resident	A type that can reside in a raw, unsized memory block. A memory Resident abstracts over the usage of a memory Lease, which itself abstracts over the allocation and ownership semantics of a raw, unsized memory block.
ResidentAdd	A + operable Resident of a raw memory Lease.
ResidentAddAssign	A += operable Resident of a raw memory Lease.
ResidentAsMut	A mutably referenceable Resident of a raw memory Lease.
ResidentAsRef	An immutably referenceable Resident of a raw memory Lease.
ResidentClone	A cloneable Resident of a raw memory Lease.
ResidentDebug	A debug-format-able Resident of a raw memory Lease.
ResidentDeref	An immutably dereferenceable Resident of a raw memory Lease.
ResidentDerefMut	A mutably dereferenceable resident of a raw memory Lease.
ResidentDisplay	A display-format-able Resident of a raw memory Lease.
ResidentEq	A comparable Resident of a raw memory Lease.
ResidentFromClone	A type that can initialize a new memory Lease with a Resident clone of a value.
ResidentFromCloneUnchecked	A type that can initialize a new memory Lease with an unchecked Resident clone of a value.
ResidentFromCopy	A type that can initialize a new memory Lease with a Resident copy of a value.
ResidentFromCopyUnchecked	A type that can initialize a new memory Lease with an unchecked Resident copy of a value.
ResidentFromEmpty	A type that can initialize a new memory Lease with an empty Resident.
ResidentFromValue	A type that can initialize a new memory Lease with a Resident value.
ResidentHash	A hashable Resident of a raw memory Lease.
ResidentIndex	An immutably indexed Resident of a raw memoryLease`.
ResidentIndexMut	A mutably indexed Resident of a raw memoryLease`.
ResidentIntoIterator	A consuming iterable Resident of a raw memory Lease.
ResidentIntoMutIterator	A mutably iterable Resident of a raw memory Lease.
ResidentIntoRefIterator	An immutably iterable Resident of a raw memory Lease.
ResidentOrd	A totally ordered Resident of a raw memory Lease.
ResidentPartialEq	A partially comparable Resident of a raw memory Lease.
ResidentPartialOrd	A partially ordered Resident of a raw memory Lease.
ResidentStow	A relocatable Resident of a raw memory Lease.
ResidentUnwrap	An unwrappable Resident of a raw memory Lease.
ResidentWithCapacity	A type that can initialize a new memory Lease with a preallocated capacity, and an empty Resident.