Struct legion::borrow::Ref

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

Implementations

impl<'a, T> Ref<'a, T> where
    T: 'a, 

pub fn new(borrow: Shared<'a>, value: &'a T) -> Ref<'a, T>

pub fn map_into<K, F>(self, f: F) -> RefMap<'a, K> where
    F: FnMut(&'a T) -> K,
    K: 'a, 

pub fn map<K, F>(&self, f: F) -> Ref<'a, K> where
    F: FnMut(&T) -> &K,
    K: 'a, 

pub unsafe fn deconstruct(self) -> (Shared<'a>, &'a T)

Deconstructs this mapped borrow to its underlying borrow state and value.

Safety

Ensure that you still follow all safety guidelines of this mapped ref.

Trait Implementations

impl<'a, T> AsRef<T> for Ref<'a, T> where
    T: 'a, 

fn as_ref(&self) -> &T

Performs the conversion.

impl<'a, T> Borrow<T> for Ref<'a, T> where
    T: 'a, 

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, T> Clone for Ref<'a, T> where
    T: 'a, 

fn clone(&self) -> Ref<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for Ref<'a, T> where
    T: 'a + Debug, 

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

Formats the value using the given formatter.

impl<'a, T> Deref for Ref<'a, T> where
    T: 'a, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Ref<'a, T> as Deref>::Target

Dereferences the value.

impl<'a, T> Eq for Ref<'a, T> where
    T: 'a + Eq, 

impl<'a, T> Hash for Ref<'a, T> where
    T: 'a + Hash, 

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a, T> Ord for Ref<'a, T> where
    T: 'a + Ord, 

fn cmp(&self, other: &Ref<'a, T>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a, T> PartialEq<Ref<'a, T>> for Ref<'a, T> where
    T: 'a + PartialEq<T>, 

fn eq(&self, other: &Ref<'a, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, T> PartialOrd<Ref<'a, T>> for Ref<'a, T> where
    T: 'a + PartialOrd<T>, 

fn partial_cmp(&self, other: &Ref<'a, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.