Enum Mutability

pub enum Mutability {
    Mutable,
    Immutable,
}

Variants

Mutable

Immutable

Implementations

impl Mutability

pub fn to_syn(&self) -> Option<Mut>

pub fn from_syn(t: &Option<Mut>) -> Self

pub fn is_mutable(&self) -> bool

Returns true if &self is the mutable variant, otherwise false.

pub fn is_immutable(&self) -> bool

Returns true if &self is the immutable variant, otherwise false.

pub fn if_mut_else<T>(&self, if_mut: T, if_immut: T) -> T

Shorthand ternary operator for choosing a value based on whether a Mutability is mutable or immutable.

The following pattern (with very slight variations) shows up often in code gen:

if mutability.is_mutable() {
    ""
} else {
    "const "
}

This is particularly annoying in write!(...) statements, where cargo fmt expands it to take up 5 lines.

This method offers a 1-line alternative:

mutability.if_mut_else("", "const ")

For cases where lazy evaluation is desired, consider using a conditional or a match statement.

Trait Implementations

impl Clone for Mutability

fn clone(&self) -> Mutability

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mutability

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Mutability

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Mutability

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 Mutability

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Mutability

impl Eq for Mutability

impl StructuralPartialEq for Mutability