Struct Ref

#[repr(transparent)]
pub struct Ref<A, T: ?Sized> {
    pub val: A,
    /* private fields */
}

A wrapper around a base type A to indicate that the value is pointing to a value of type T.

This is not a strict type safety barrier; it is possible to convert a Ref to and from its raw version. However this can help in API documentation, as well as to assist type inference in functions like LocalMap::get.

Fields

val: A

The underlying storage or “raw” value.

Implementations

impl<A, T: ?Sized> Ref<A, T>

pub fn new(val: A) -> Self

Construct a new Ref by wrapping a raw value.

Trait Implementations

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

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: Debug, T: ?Sized> Debug for Ref<A, T>

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

Formats the value using the given formatter.

impl<A, T: ?Sized> Deref for Ref<A, T>

type Target = A

The resulting type after dereferencing.

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

Dereferences the value.

impl<A: Display, T: ?Sized> Display for Ref<A, T>

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

Formats the value using the given formatter.

impl<A: FromStr, T: ?Sized> FromStr for Ref<A, T>

type Err = <A as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a, T: ?Sized> Index<&Ref<String, T>> for LocalMap<'a, T>

type Output = T

The returned type after indexing.

fn index(&self, index: &NameRef<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: HasId + ?Sized> Index<&Ref<String, T>> for LocalMaps<'a>

type Output = T

The returned type after indexing.

fn index(&self, index: &NameRef<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: ?Sized> Index<&Ref<Url, T>> for LocalMap<'a, T>

type Output = T

The returned type after indexing.

fn index(&self, index: &UrlRef<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: HasId + ?Sized> Index<&Ref<Url, T>> for LocalMaps<'a>

type Output = T

The returned type after indexing.

fn index(&self, index: &UrlRef<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A, T: ?Sized> RefCast for Ref<A, T>

type From = A

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

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