Enum move_binary_format::file_format::Ability

#[repr(u8)]
pub enum Ability {
    Copy,
    Drop,
    Store,
    Key,
}

An Ability classifies what operations are permitted for a given type

Variants

Copy

Allows values of types with this ability to be copied, via CopyLoc or ReadRef

Drop

Allows values of types with this ability to be dropped, via Pop, WriteRef, StLoc, Eq, Neq, or if left in a local when Ret is invoked Technically also needed for numeric operations (Add, BitAnd, Shift, etc), but all of the types that can be used with those operations have Drop

Store

Allows values of types with this ability to exist inside a struct in global storage

Key

Allows the type to serve as a key for global storage operations: MoveTo, MoveFrom, etc.

Implementations

impl Ability

pub fn requires(self) -> Self

For a struct with ability a, each field needs to have the ability a.requires(). Consider a generic type Foo<t1, …, tn>, for Foo<t1, …, tn> to have ability a, Foo must have been declared with a and each type argument ti must have the ability a.requires()

pub fn required_by(self) -> AbilitySet

An inverse of requires, where x is in a.required_by() iff x.requires() == a

Trait Implementations

impl BitOr<Ability> for AbilitySet

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, rhs: Ability) -> Self

Performs the | operation.

impl Clone for Ability

fn clone(&self) -> Ability

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ability

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

Formats the value using the given formatter.

impl Hash for Ability

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Ability

fn cmp(&self, other: &Ability) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Ability> for Ability

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Ability> for Ability

fn partial_cmp(&self, other: &Ability) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Ability

impl Eq for Ability

impl StructuralEq for Ability

impl StructuralPartialEq for Ability