Struct left_right::aliasing::Aliased

#[repr(transparent)]pub struct Aliased<T, D> where
    D: DropBehavior,  { /* fields omitted */ }

A T that is aliased.

You should be able to mostly ignore this type, as it can generally be treated exactly like a &T. However, there are some minor exceptions around forwarding traits -- since Aliased is a wrapper type around T, it cannot automatically forward traits it does not know about to &T. This means that if your &T implements, say, Serialize or some custom Borrow<Q>, Aliased<T> will not implement that same trait. You can work around this either by implementing your trait specifically for Aliased<T> where possible, or by manually dereferencing to get the &T before using the trait.

Implementations

impl<T, D> Aliased<T, D> where
    D: DropBehavior, 

pub unsafe fn alias(&self) -> Self

Create an alias of the inner T.

Safety

This method is only safe to call as long as you ensure that the alias is never used after an Aliased<T, D> of self where D::DO_DROP is true is dropped, and as long as no &mut T is ever given out while some Aliased<T> may still be used. The returned type assumes that it is always safe to dereference into &T, which would not be true if either of those invariants were broken.

pub fn from(t: T) -> Self

Construct an aliased value around a T.

This method is safe since it effectively leaks T. Note that we do not implement From<T> because we do not want users to construct Aliased<T>s on their own. If they did, they would almost certain end up with incorrect drop behavior.

pub unsafe fn change_drop<D2: DropBehavior>(self) -> Aliased<T, D2>

Turn this aliased T into one with a different drop behavior.

Safety

It is always safe to change an Aliased from a dropping D to a non-dropping D. Going the other way around is only safe if self is the last alias for the T.

Trait Implementations

impl<T, D> AsRef<T> for Aliased<T, D> where
    D: DropBehavior, 

pub fn as_ref(&self) -> &T

Performs the conversion.

impl<T, D> Borrow<[T]> for Aliased<Vec<T>, D> where
    D: DropBehavior, 

pub fn borrow(&self) -> &[T]

Immutably borrows from an owned value.

impl<D> Borrow<Path> for Aliased<PathBuf, D> where
    D: DropBehavior, 

pub fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl<T, D> Borrow<T> for Aliased<T, D> where
    D: DropBehavior, 

pub fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, D> Borrow<T> for Aliased<Box<T>, D> where
    T: ?Sized,
    D: DropBehavior, 

pub fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, D> Borrow<T> for Aliased<Arc<T>, D> where
    T: ?Sized,
    D: DropBehavior, 

pub fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, D> Borrow<T> for Aliased<Rc<T>, D> where
    T: ?Sized,
    D: DropBehavior, 

pub fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<D> Borrow<str> for Aliased<String, D> where
    D: DropBehavior, 

pub fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T, D> Debug for Aliased<T, D> where
    D: DropBehavior,
    T: Debug, 

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

Formats the value using the given formatter.

impl<T, D> Deref for Aliased<T, D> where
    D: DropBehavior, 

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, D> Drop for Aliased<T, D> where
    D: DropBehavior, 

pub fn drop(&mut self)

Executes the destructor for this type.

impl<T, D> Eq for Aliased<T, D> where
    D: DropBehavior,
    T: Eq, 

impl<T, D> Hash for Aliased<T, D> where
    D: DropBehavior,
    T: Hash, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T, D> Ord for Aliased<T, D> where
    D: DropBehavior,
    T: Ord, 

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T, D> PartialEq<Aliased<T, D>> for Aliased<T, D> where
    D: DropBehavior,
    T: PartialEq, 

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

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

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

This method tests for !=.

impl<T, D> PartialOrd<Aliased<T, D>> for Aliased<T, D> where
    D: DropBehavior,
    T: PartialOrd, 

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

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

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

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

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

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

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

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

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

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

impl<T, D> Send for Aliased<T, D> where
    D: DropBehavior,
    T: Send + Sync, 

impl<T, D> Sync for Aliased<T, D> where
    D: DropBehavior,
    T: Sync,