Struct TotalSize

pub struct TotalSize { /* private fields */ }

Represents the total space taken up by an instance of a variable, including heap allocations

Implementations

impl TotalSize

pub const fn new( total_bytes: usize, excess_bytes: usize, shared_bytes: usize, distinct_allocations: usize, ) -> Self

Creates a new TotalSize

pub const fn zero() -> Self

Creates a TotalSize with a value of zero

pub const fn total(total: usize) -> Self

Sets total_bytes to total and all others to zero

pub const fn total_bytes(&self) -> usize

Returns the total bytes allocated

pub const fn excess_bytes(&self) -> usize

Returns the excess bytes allocated, the unused portions of allocated memory

pub const fn shared_bytes(&self) -> usize

Returns the number of shared bytes, bytes that are shared behind things like Arc or Rc

pub const fn distinct_allocations(&self) -> usize

Returns the number of distinct allocations

For example, a Box<u32> contains one distinct allocation while a Box<Box<u32>> contains two

pub const fn used_bytes(&self) -> usize

Return the total used bytes, calculated by total_bytes - excess_bytes

Trait Implementations

impl Add for TotalSize

type Output = TotalSize

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for TotalSize

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for TotalSize

fn clone(&self) -> TotalSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TotalSize

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

Formats the value using the given formatter.

impl Default for TotalSize

fn default() -> TotalSize

Returns the “default value” for a type.

impl Hash for TotalSize

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 Ord for TotalSize

fn cmp(&self, other: &TotalSize) -> 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 PartialEq for TotalSize

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TotalSize

fn partial_cmp(&self, other: &TotalSize) -> 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 SizeOf for TotalSize

fn size_of_children(&self, _context: &mut Context)

Gets the size of all “children” owned by this value, not including the size of the value itself.

fn size_of(&self) -> TotalSize

Gets the total size of the current value

fn size_of_with_context(&self, context: &mut Context)

Adds the size of the current value to the given Context, including both the size of the value itself and all of its children

impl Sub for TotalSize

type Output = TotalSize

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for TotalSize

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for TotalSize

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for TotalSize

impl Eq for TotalSize

impl StructuralPartialEq for TotalSize