Struct size_of::Context

pub struct Context { /* private fields */ }

The context of a size query, used to keep track of shared pointers and the aggregated totals of seen data

Implementations

impl Context

pub fn new() -> Self

Creates a new, empty context

pub const fn is_shared(&self) -> bool

Returns true if the current context is shared

pub fn shared<F>(&mut self, with_shared: F) -> &mut Selfwhere
    F: FnOnce(&mut Self),

Run the given closure and mark all added allocations as shared

pub fn add_distinct_allocation(&mut self) -> &mut Self

Adds one distinct allocation to the current context

pub fn add_distinct_allocations(&mut self, allocations: usize) -> &mut Self

Adds allocations distinct allocations to the current context

pub fn add(&mut self, size: usize) -> &mut Self

Adds size to the total bytes

• Adds size to the shared bytes if the context is currently shared

pub fn add_shared(&mut self, size: usize) -> &mut Self

Adds size shared bytes

pub fn add_excess(&mut self, size: usize) -> &mut Self

Adds size to the total and excess bytes

• Adds size to the shared bytes if the context is currently shared

pub fn add_arraylike(&mut self, len: usize, element_size: usize) -> &mut Self

Adds a vector-like object to the current context.

• Adds len * element_size to the total bytes
• Adds len * element_size to the shared bytes if the context is currently shared

pub fn add_vectorlike(
    &mut self,
    len: usize,
    capacity: usize,
    element_size: usize
) -> &mut Self

Adds a vector-like object to the current context.

• Adds capacity * element_size to the total bytes
• Adds (capacity - len) * element_size to the excess bytes
• Adds capacity * element_size to the shared bytes if the context is currently shared

pub fn insert_ptr<T: ?Sized>(&mut self, ptr: *const T) -> bool

Returns true and adds the given pointer to the current context if it hasn’t seen it yet. Returns false if the current context has seen the pointer before

pub fn add_ptr<T: ?Sized>(&mut self, ptr: *const T) -> &mut Self

Adds the given pointer to the current context regardless of whether it’s seen it yet

pub fn contains_ptr<T: ?Sized>(&self, ptr: *const T) -> bool

Returns true if the context has seen the given pointer

pub const fn total_size(&self) -> TotalSize

Returns the total size of all objects the current context has seen

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Context

Returns the “default value” for a type.

impl SizeOf for Context

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