Enum StorageClass 

pub enum StorageClass {
    Static,
    Automatic,
    Allocated,
    Mapped,
    Mmio,
    Device,
    Function,
    Literal,
}

What kind of storage a memory safety instance is, which is class of spec/safe-memory/04-safety-model.md section 4.1.

It is on meta_begin because judgement J4 writes it when the instance is created, and the one place it is read afterwards is J6: free is permitted on an allocated instance and on no other kind, which is what makes freeing a stack address a report rather than a crash in the allocator.

Variants

Static

A global or a static local, which lives as long as the program does.

Automatic

A local, which lives as long as its block does.

Allocated

Storage an allocator handed out, and the only kind free may be given.

Mapped

A mapping, from mmap or its equivalent.

Mmio

A device register window, where a read is not a read of anything the program wrote.

Device

Storage a device owns, which is what a DMA buffer is while the transfer runs.

Function

A function, which is what the address of one points at.

Literal

A string or compound literal, which the implementation may have merged with another.

Implementations

impl StorageClass

pub const fn name(self) -> &'static str

The textual form.

pub fn from_name(name: &str) -> Option<Self>

The class with that name, if there is one.

pub fn all() -> impl Iterator<Item = Self>

Every class, in the order document 04 lists them.

Trait Implementations

impl Clone for StorageClass

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StorageClass

impl Debug for StorageClass

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

Formats the value using the given formatter.

impl Display for StorageClass

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

Formats the value using the given formatter.

impl Eq for StorageClass

impl Hash for StorageClass

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 StorageClass

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for StorageClass

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StorageClass

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for StorageClass