Struct write_only::WriteOnlyRef

pub struct WriteOnlyRef<'a, T: 'a> { /* fields omitted */ }

A write-only reference with dropping non-volatile write access.

Implementations

impl<'a, T: 'a> WriteOnlyRef<'a, T>

pub unsafe fn from_ptr(data: *mut T) -> Self

Forms a write-only reference from a pointer.

Safety

Behavior is undefined if any of the following conditions are violated:

• data must be valid for reads for len * mem::size_of::<T>() many bytes, and it must be properly aligned. This means in particular:

  • data must be non-null and aligned. One reason for this is that enum layout optimizations may rely on references being aligned and non-null to distinguish them from other data.

• The memory referenced by the returned reference must not be mutated for the duration of lifetime 'a, except inside an UnsafeCell.

Caveat

The lifetime for the returned reference is inferred from its usage. To prevent accidental misuse, it’s suggested to tie the lifetime to whichever source lifetime is safe in the context, such as by providing a helper function taking the lifetime of a host guard for the reference, or by explicit annotation.

Trait Implementations

impl<'a, T: 'a> From<&'a mut T> for WriteOnlyRef<'a, T>

fn from(borrow: &'a mut T) -> Self

Performs the conversion.

impl<'a, T: 'a> Put<T> for WriteOnlyRef<'a, T>

fn put(&mut self, guard: T)

Puts the value the given value, dropping the old value.

impl<'a, T: 'a> Write<T> for WriteOnlyRef<'a, T>

fn write(&mut self, guard: T)

Writes the value the given value without dropping the old value.