Enum orx_pinned_vec::CapacityState

pub enum CapacityState {
    FixedCapacity(usize),
    DynamicCapacity {
        current_capacity: usize,
        maximum_concurrent_capacity: usize,
    },
}

Provides detailed information of capacity state of the pinned vector.

This information contains the current capacity which can be obtained by capacity() method and extends with additional useful information.

• FixedCapacity variant only provides the current capacity. However, its additional tag informs that this capacity is a hard constraint and the vector cannot grow beyond it.
• DynamicCapacity variant informs that the vector is capable of allocating and growing its capacity. It provides current_capacity representing the current internal state of the vector. Additionally, maximum_concurrent_capacity is provided. This number represents the maximum number of elements that can safely be pushed to the vector in a concurrent program.

Variants

FixedCapacity(usize)

FixedCapacity variant only provides the current capacity. However, its additional tag informs that this capacity is a hard constraint and the vector cannot grow beyond it.

DynamicCapacity

DynamicCapacity variant informs that the vector is capable of allocating and growing its capacity. It provides current_capacity representing the current internal state of the vector. Additionally, maximum_concurrent_capacity is provided. This number represents the maximum number of elements that can safely be pushed to the vector in a concurrent program. This value is often related with the capacity of the container holding meta information about allocations. Note that the dynamic vector can naturally grow beyond this number, this bound is only relevant when the vector is Synced among threads.

Fields

current_capacity: usize

Capacity of current allocations owned by the vector.

maximum_concurrent_capacity: usize

Maximum capacity that can safely be reached by the vector in a concurrent program. This value is often related with the capacity of the container holding meta information about allocations. Note that the dynamic vector can naturally grow beyond this number, this bound is only relevant when the vector is Synced among threads.

Implementations

impl CapacityState

pub fn current_capacity(&self) -> usize

Capacity of current allocations owned by the vector.

pub fn maximum_concurrent_capacity(&self) -> usize

Maximum capacity that can safely be reached by the vector in a concurrent program. This value is often related with the capacity of the container holding meta information about allocations. Note that the dynamic vector can naturally grow beyond this number, this bound is only relevant when the vector is Synced among threads.

Trait Implementations

impl Clone for CapacityState

fn clone(&self) -> CapacityState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CapacityState

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

Formats the value using the given formatter.

impl PartialEq for CapacityState

fn eq(&self, other: &CapacityState) -> 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 Copy for CapacityState

impl Eq for CapacityState

impl StructuralPartialEq for CapacityState