Skip to main content

Ref

Struct Ref 

Source
pub struct Ref<'a, T: 'a + ?Sized> { /* private fields */ }
Expand description

A lightweight wrapper around a non-null pointer for a shared reference.

The wrappers are useful when you need a pointer instead of a reference while not degrading usage and keeping its provenance. For instance, if you make the Ref from a mutable reference, the fact the type is made from “mutable” won’t be lost, which is an information which some tools, such as miri, used for finding pointer safety violations.

Implementations§

Source§

impl<'a, T: 'a + ?Sized> Ref<'a, T>

Source

pub const fn from_ref(r: &'a T) -> Self

Source

pub fn from_mut(r: &'a mut T) -> Self

Source

pub fn as_ref(&self) -> &'a T

Source

pub const fn as_nonnull(self) -> NonNull<T>

Source

pub const fn as_ptr(self) -> *mut T

Trait Implementations§

Source§

impl<'a, T: 'a + ?Sized> Clone for Ref<'a, T>

Source§

fn clone(&self) -> Self

Returns a duplicate 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<'a, T: Debug + 'a + ?Sized> Debug for Ref<'a, T>

Source§

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

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

impl<'a, T: 'a + ?Sized> Copy for Ref<'a, T>

Auto Trait Implementations§

§

impl<'a, T> Freeze for Ref<'a, T>
where T: ?Sized,

§

impl<'a, T> RefUnwindSafe for Ref<'a, T>
where T: RefUnwindSafe + ?Sized,

§

impl<'a, T> !Send for Ref<'a, T>

§

impl<'a, T> !Sync for Ref<'a, T>

§

impl<'a, T> Unpin for Ref<'a, T>
where T: ?Sized,

§

impl<'a, T> UnsafeUnpin for Ref<'a, T>
where T: ?Sized,

§

impl<'a, T> UnwindSafe for Ref<'a, T>
where T: RefUnwindSafe + ?Sized,

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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 T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
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>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.