Struct Writable

pub struct Writable<T> { /* private fields */ }

A type wrapper that indicates a register type is writable. The underlying register can be extracted, and the type wrapper can be built using an arbitrary register. Hence, this type-level wrapper is not strictly a guarantee. However, “casting” to a writable register is an explicit operation for which we can audit. Ordinarily, internal APIs in the compiler backend should take a Writable<Reg> whenever the register is written, and the usual, frictionless way to get one of these is to allocate a new temporary.

Implementations

impl<T> Writable<T>

pub fn from_reg(reg: T) -> Writable<T>

Explicitly construct a Writable<T> from a T. As noted in the documentation for Writable, this is not hidden or disallowed from the outside; anyone can perform the “cast”; but it is explicit so that we can audit the use sites.

pub fn to_reg(self) -> T

Get the underlying register, which can be read.

pub fn reg_mut(&mut self) -> &mut T

Get a mutable borrow of the underlying register.

pub fn map<U>(self, f: impl Fn(T) -> U) -> Writable<U>

Map the underlying register to another value or type.

Trait Implementations

impl<T: Clone> Clone for Writable<T>

fn clone(&self) -> Writable<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Writable<T>

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

Formats the value using the given formatter.

impl<'a> From<&'a Writable<FReg>> for FReg

Available on crate feature pulley only.

fn from(r: &'a Writable<FReg>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Writable<VReg>> for VReg

Available on crate feature pulley only.

fn from(r: &'a Writable<VReg>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Writable<XReg>> for XReg

Available on crate feature pulley only.

fn from(r: &'a Writable<XReg>) -> Self

Converts to this type from the input type.

impl From<Writable<FReg>> for FReg

Available on crate feature pulley only.

fn from(r: Writable<FReg>) -> Self

Converts to this type from the input type.

impl From<Writable<Reg>> for RegMem

Available on crate feature x86 only.

fn from(r: Writable<Reg>) -> Self

Converts to this type from the input type.

impl From<Writable<VReg>> for VReg

Available on crate feature pulley only.

fn from(r: Writable<VReg>) -> Self

Converts to this type from the input type.

impl From<Writable<XReg>> for XReg

Available on crate feature pulley only.

fn from(r: Writable<XReg>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Writable<T>

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<T: Ord> Ord for Writable<T>

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

impl<T: PartialEq> PartialEq for Writable<T>

fn eq(&self, other: &Writable<T>) -> 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<T: PartialOrd> PartialOrd for Writable<T>

fn partial_cmp(&self, other: &Writable<T>) -> 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 TryFrom<Writable<Reg>> for Writable<FReg>

Available on crate feature pulley only.

type Error = ()

The type returned in the event of a conversion error.

fn try_from(r: Writable<Reg>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Writable<Reg>> for Writable<VReg>

Available on crate feature pulley only.

type Error = ()

The type returned in the event of a conversion error.

fn try_from(r: Writable<Reg>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Writable<Reg>> for Writable<XReg>

Available on crate feature pulley only.

type Error = ()

The type returned in the event of a conversion error.

fn try_from(r: Writable<Reg>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Copy> Copy for Writable<T>

impl<T: Eq> Eq for Writable<T>

impl<T> StructuralPartialEq for Writable<T>