Struct Unsafe

pub struct Unsafe<O: ?Sized, F: ?Sized, const NAME_HASH: u128> { /* private fields */ }

A field with safety invariants.

Unsafe should not be named directly - instead, use unsafe_fields! to declare a type with unsafe fields.

See the crate-level documentation for more information.

Implementations

impl<O: ?Sized, F: ?Sized, const NAME_HASH: u128> Unsafe<O, F, NAME_HASH>

pub const unsafe fn as_ref_unchecked(&self) -> &F

Gets a reference to the inner value.

If F: Immutable, prefer as_ref, which is safe.

Safety

The caller is responsible for upholding any safety invariants associated with this field.

pub const fn as_ref(&self) -> &F

where F: Immutable,

Available on crate feature zerocopy_0_8 only.

Gets a reference to the inner value safely so long as the inner value is immutable.

If F: Immutable, then F does not permit interior mutation, and so it is safe to return a reference to it.

pub unsafe fn as_mut(&mut self) -> &mut F

Gets a mutable reference to the inner value.

Safety

The caller is responsible for upholding any safety invariants associated with this field.

impl<O: ?Sized, F, const NAME_HASH: u128> Unsafe<O, F, NAME_HASH>

pub const unsafe fn new(field: F) -> Unsafe<O, F, NAME_HASH>

Constructs a new Unsafe.

Safety

The caller is responsible for upholding any safety invariants associated with this field.

pub const fn into(self) -> F

Extracts the inner F from self.

Trait Implementations

impl<O: ?Sized, F: Copy, const NAME_HASH: u128> Clone for Unsafe<O, F, NAME_HASH>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: ?Sized, F: Copy, const NAME_HASH: u128> Copy for Unsafe<O, F, NAME_HASH>