Struct Compact 

pub struct Compact<T: CompactRepr>(pub T);

Owning compact value. Marks a struct field for bit-packed storage when the containing struct is derived with #[derive(SOA)].

Tuple Fields

0: T

Implementations

impl<T: CompactRepr> Compact<T>

pub fn new(value: T) -> Self

Wrap a value for compact storage.

pub fn get(&self) -> T

Read the contained value.

pub fn set(&mut self, value: T)

Overwrite the contained value.

pub fn as_mut(&mut self) -> CompactRefMut<'_, T>

Build a mutable handle to this value (used by the generated RefMut construction). Writes through the handle propagate back here immediately via CompactRefMut::set.

pub fn as_ptr(&self) -> CompactPtr<T>

Returns a direct pointer to this value, so an element pointer derived from a Ref is never misclassified as null. Unlike column pointers, it is valid only while this Compact lives (for the compact field of a Ref, that is the Ref itself, not the underlying vec).

Trait Implementations

impl<T: Clone + CompactRepr> Clone for Compact<T>

fn clone(&self) -> Compact<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy + CompactRepr> Copy for Compact<T>

impl<T: Debug + CompactRepr> Debug for Compact<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default + CompactRepr> Default for Compact<T>

fn default() -> Compact<T>

Returns the “default value” for a type.

impl<T: CompactRepr> Deref for Compact<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: CompactRepr> DerefMut for Compact<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Eq + CompactRepr> Eq for Compact<T>

impl<T: CompactRepr> Extend<Compact<T>> for CompactVec<T>

fn extend<I: IntoIterator<Item = Compact<T>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, T: CompactRepr> From<&'a CompactRefMut<'a, T>> for Compact<T>

fn from(value: &'a CompactRefMut<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: CompactRepr> From<CompactRefMut<'a, T>> for Compact<T>

fn from(value: CompactRefMut<'a, T>) -> Self

Converts to this type from the input type.

impl<T: CompactRepr> From<T> for Compact<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: CompactRepr> FromIterator<Compact<T>> for CompactVec<T>

fn from_iter<I: IntoIterator<Item = Compact<T>>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash + CompactRepr> Hash for Compact<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + CompactRepr> Ord for Compact<T>

fn cmp(&self, other: &Compact<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + CompactRepr> PartialEq for Compact<T>

fn eq(&self, other: &Compact<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: CompactRepr + PartialEq> PartialEq<T> for Compact<T>

fn eq(&self, other: &T) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialOrd + CompactRepr> PartialOrd for Compact<T>

fn partial_cmp(&self, other: &Compact<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: CompactRepr + PartialOrd> PartialOrd<T> for Compact<T>

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: CompactRepr> SOA for Compact<T>

type Type = CompactVec<T>

impl<'a, T: CompactRepr> SoAIter<'a> for Compact<T>

type Ref = Compact<T>

type RefMut = CompactRefMut<'a, T>

type Iter = CompactIter<'a, T>

type IterMut = CompactIterMut<'a, T>

impl<T: CompactRepr> SoAPointers for Compact<T>

type Ptr = CompactPtr<T>

The immutable pointer type for an SoA type

type MutPtr = CompactPtrMut<T>

The mutable pointer type for an SoA type

impl<T: PartialEq + CompactRepr> StructuralPartialEq for Compact<T>