# ReadOnly in volatile - Rust
A volatile wrapper which only allows read operations.
Keywords: rust, rustlang, rust-lang, ReadOnly

# Struct volatile::ReadOnly

source · [−]

    pub struct ReadOnly<T: Copy>(_);

Expand description

A volatile wrapper which only allows read operations.

The size of this struct is the same as the contained type.

## Implementations

source

### impl<T: Copy> ReadOnly<T>

source

#### pub fn new(value: T) -> ReadOnly<T>

Construct a new read-only volatile wrapper wrapping the given value.

    use volatile::ReadOnly;

    let value = ReadOnly::new(42u32);

##### Panics

This function never panics.

source

#### pub fn read(&self) -> T

Perform a volatile read of the contained value, returning a copy of the read value. Functionally equivalent to `Volatile::read`.

    use volatile::ReadOnly;

    let value = ReadOnly::new(42u32);
    assert_eq!(value.read(), 42u32);

##### Panics

This function never panics.

## Trait Implementations

source

### impl<T: Clone + Copy> Clone for ReadOnly<T>

source

#### fn clone(&self) -> ReadOnly<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 + Copy> Debug for ReadOnly<T>

source

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

Formats the value using the given formatter. Read more

source

### impl<T: Default + Copy> Default for ReadOnly<T>

source

#### fn default() -> ReadOnly<T>

Returns the “default value” for a type. Read more

## Auto Trait Implementations

### impl<T> RefUnwindSafe for ReadOnly<T> where
T: RefUnwindSafe,

### impl<T> Send for ReadOnly<T> where
T: Send,

### impl<T> Sync for ReadOnly<T> where
T: Sync,

### impl<T> Unpin for ReadOnly<T> where
T: Unpin,

### impl<T> UnwindSafe for ReadOnly<T> where
T: UnwindSafe,

## Blanket Implementations

source

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

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

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

Mutably borrows from an owned value. Read more

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 T where
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, U> TryFrom<U> for T where
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 T where
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.