Struct soapy::Ref

pub struct Ref<'a, T>(/* private fields */)
where
    T: 'a + Soapy;

An immutable reference to an element of a Soa.

This is similar to &T for an element of a &[T]. However, since the fields are stored separately for SoA, we need a different type that has references to each of fields for the element. This is a convenience wrapper over Soapy::Ref, which is implemented for each type that derives Soapy. It uses WithRef to provide implementations of common standard library traits with less codegen and ceremony than doing the same in the macro.

Trait Implementations

impl<'a, T> AsRef<<T as Soapy>::Ref<'a>> for Ref<'a, T>

where T: Soapy,

fn as_ref(&self) -> &T::Ref<'a>

Converts this type into a shared reference of the (usually inferred) input type.

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

where T: 'a + Soapy + Clone, T::Ref<'a>: Clone,

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: Soapy + Debug,

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

Formats the value using the given formatter.

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

where T: Soapy,

type Target = <T as Soapy>::Ref<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T> Hash for Ref<'a, T>

where T: Soapy + Hash,

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<'a, T> Ord for Ref<'a, T>

where T: Soapy + Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a, T, U, R> PartialEq<R> for Ref<'a, T>

where T: Soapy + PartialEq<U>, R: WithRef<Item = U>,

fn eq(&self, other: &R) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T, U, R> PartialOrd<R> for Ref<'a, T>

where T: Soapy + PartialOrd<U>, R: WithRef<Item = U>,

fn partial_cmp(&self, other: &R) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl<'a, T> WithRef for Ref<'a, T>

where T: Soapy,

type Item = T

The type to be borrowed.

fn with_ref<F, U>(&self, f: F) -> U

where F: FnOnce(&Self::Item) -> U,

Calls the provided function with a reference to T

impl<'a, T> Copy for Ref<'a, T>

where T: 'a + Soapy + Copy, T::Ref<'a>: Copy,

impl<'a, T> Eq for Ref<'a, T>

where T: 'a + Soapy + Eq,