Enum EscapeStatus 

pub enum EscapeStatus {
    NoEscape,
    LocalEscape,
    HeapEscape,
    ReturnEscape,
    ArgumentEscape(usize),
    Unknown,
}

The escape status of an allocation site.

Variants

NoEscape

The allocation does not escape: safe for stack allocation.

LocalEscape

The allocation escapes to a local variable only.

HeapEscape

The allocation escapes to the heap (assigned to a heap-allocated struct).

ReturnEscape

The allocation is returned from the function.

ArgumentEscape(usize)

The allocation escapes as argument index usize of some call.

Unknown

Escape status is unknown (conservative assumption).

Implementations

impl EscapeStatus

pub fn is_heap_allocated(&self) -> bool

Returns true if this allocation must live on the heap.

pub fn can_stack_allocate(&self) -> bool

Returns true if this allocation can be placed on the stack.

Trait Implementations

impl Clone for EscapeStatus

fn clone(&self) -> EscapeStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EscapeStatus

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

Formats the value using the given formatter.

impl Hash for EscapeStatus

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 PartialEq for EscapeStatus

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

impl StructuralPartialEq for EscapeStatus