pub struct Writable<T: Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> { /* private fields */ }
Expand description

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§

source§

impl<T: Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> Writable<T>

source

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.

source

pub fn to_reg(self) -> T

Get the underlying register, which can be read.

source

pub fn map<U, F>(self, f: F) -> Writable<U>where U: Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash, F: Fn(T) -> U,

Map the underlying register to another value or type.

Trait Implementations§

source§

impl<T: Clone + Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> Clone for Writable<T>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug + Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> Debug for Writable<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Writable<Reg>> for RegMem

source§

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

Converts to this type from the input type.
source§

impl<T: Hash + Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> Hash for Writable<T>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T: Ord + Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> Ord for Writable<T>

source§

fn cmp(&self, other: &Writable<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl<T: PartialEq + Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> PartialEq<Writable<T>> for Writable<T>

source§

fn eq(&self, other: &Writable<T>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T: PartialOrd + Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> PartialOrd<Writable<T>> for Writable<T>

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl<T: Copy + Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> Copy for Writable<T>

source§

impl<T: Eq + Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> Eq for Writable<T>

source§

impl<T: Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> StructuralEq for Writable<T>

source§

impl<T: Clone + Copy + Debug + PartialEq + Eq + PartialOrd + Ord + Hash> StructuralPartialEq for Writable<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Writable<T>where T: RefUnwindSafe,

§

impl<T> Send for Writable<T>where T: Send,

§

impl<T> Sync for Writable<T>where T: Sync,

§

impl<T> Unpin for Writable<T>where T: Unpin,

§

impl<T> UnwindSafe for Writable<T>where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CallHasher for Twhere T: Hash + ?Sized,

§

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where H: Hash + ?Sized, B: BuildHasher,

source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.