Struct OxRef 

pub struct OxRef<'a> {
    pub shape: &'static Shape,
    /* private fields */
}

Safe read-only reference with shape.

Unlike OxPtrConst, this has a lifetime parameter for borrow checking.

Fields

shape: &'static Shape

The shape describing the type.

Implementations

impl<'a> OxRef<'a>

pub const fn new(ptr: PtrConst, shape: &'static Shape) -> Self

Create a new OxRef from a pointer and shape.

pub const fn ptr(&self) -> PtrConst

Get the underlying pointer.

pub const fn shape(&self) -> &'static Shape

Get the shape.

pub unsafe fn get_as<T: 'static>( &self, expected_shape: &'static Shape, ) -> Option<&'a T>

Get a typed reference if the shape matches.

Safety

The caller must ensure that T is the correct type for expected_shape.

pub const fn as_ptr_const(&self) -> OxPtrConst

Convert to an unlifetimed OxPtrConst.

Trait Implementations

impl<'a> Clone for OxRef<'a>

fn clone(&self) -> OxRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OxRef<'_>

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

Formats the value using the given formatter.

impl Display for OxRef<'_>

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

Formats the value using the given formatter.

impl<'a> From<OxRef<'a>> for OxPtrConst

fn from(ox: OxRef<'a>) -> Self

Converts to this type from the input type.

impl Hash for OxRef<'_>

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 PartialEq for OxRef<'_>

fn eq(&self, other: &Self) -> 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 PartialOrd for OxRef<'_>

fn partial_cmp(&self, other: &Self) -> 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<'a> Copy for OxRef<'a>