source
Namespace Subspace :: sus

The root namespace of the Subspace C++ library.

Everything in the library lives in nested namespaces, for the most part, but some common things are promoted up to the sus namespace as aliases.

Namespaces

assertions

Checking for (e.g. sus_check) and handling (e.g. sus_panic, sus_unreachable) unexpected runtime conditions.
boxed

The Box<T> type for heap allocation and other tools for type-erasure of concepts.
choice_type

The Choice type.
cmp

Utilities for comparing and ordering values.
collections

Collection types.
compat
construct

Concepts and functions for constructing and converting between types.
env

Inspection and manipulation of the process's environment.
error

Interfaces for working with Errors.
fn

The Fn, FnMut and FnOnce concepts for working with functors and callable types.
iter

Composable external iteration.
marker

Marker types, such as for accessing unsafe APIs, for overload resolution, or type elision.
mem
num

Safe integer (e.g. i32) and floating point (e.g. f32) numerics, and numeric concepts.
ops
option

The Option type, and the some and none type-deduction constructor functions.
prelude

Commonly used things that can be pulled into the global top level namespace. This is done by default when including the sus/prelude.h header.
ptr
result

The Result type, and the ok and err type-deduction constructor functions.
tuple_type

The Tuple type, and the tuple type-deduction constructor function.

Array

A collection of objects of type T, with a fixed size N.
Box

A heap allocated object.
Choice

A tagged union, or sum type.
Option

The Option type.
Result
Slice

A dynamically-sized const view into a contiguous sequence of objects of type const T.
SliceMut

A dynamically-sized mutable view into a contiguous sequence of objects of type T.
Tuple

A Tuple is a finite sequence of one or more heterogeneous values.
Vec

A resizeable contiguous buffer of type T.
f32

A 32-bit floating point type.
f64

A 64-bit floating point type.
i16

A 16-bit signed integer.
i32

A 32-bit signed integer.
i64

A 64-bit signed integer.
i8

An 8-bit signed integer.
isize

An address-sized signed integer.
u16

A 16-bit unsigned integer.
u32

A 32-bit unsigned integer.
u64

A 64-bit unsigned integer.
u8

An 8-bit unsigned integer.
uptr

A pointer-sized unsigned integer.
usize

An address-sized unsigned integer.

cast

An infallible conversion (cast) that may lose the original value in the process.
clone

Clones the input either by copying or cloning. Returns a new object of type T.
clone_into

Performs copy-assignment from source.
data_size_of

Returns the data size of the type T.
dyn

Type erases a reference to a type T& which satisfies a concept C, into a reference DynC& that also satisfies C but without templates.
err

Used to construct a Result<T, E> with an Err(e) value.
forward

Move from non-reference values but pass through and preserve references.
into

Converts from the given value to whatever a receiver requires.
move

Cast t to an r-value reference so that it can be used to construct or be assigned to a (non-reference) object of type T.
move_into

Moves from and converts from the given value to whatever a receiver requires.
none

Used to construct an option with a None value.
ok

Used to construct a Result<T, E> with an Ok(t) value.
size_of

Returns the size of the type T.
some

Used to construct an option with a Some(t) value.
try_into

Attempts to convert from the given value to a ToType.
tuple

Used to construct a Tuple with the parameters as its values.

empty

The global EmptyMarker which can be passed to constructors to allow type deduction instead of having to write out the full default constructor.