Enum bevy_utils::CowArc

source ·
pub enum CowArc<'a, T: ?Sized + 'static> {
    Borrowed(&'a T),
    Static(&'static T),
    Owned(Arc<T>),
}
Expand description

Much like a Cow, but owned values are Arc-ed to make clones cheap. This should be used for values that are cloned for use across threads and change rarely (if ever).

This also makes an opinionated tradeoff by adding a CowArc::Static and implementing [From<&'static T>] instead of [From<'a T>]. This preserves the static context and prevents conversion to CowArc::Owned in cases where a reference is known to be static. This is an optimization that prevents allocations and atomic ref-counting.

This means that static references should prefer From::from or CowArc::Static and non-static references must use CowArc::Borrowed.

Variants§

§

Borrowed(&'a T)

A borrowed value

§

Static(&'static T)

A static value reference. This exists to avoid conversion to CowArc::Owned in cases where a reference is known to be static. This is an optimization that prevents allocations and atomic ref-counting.

§

Owned(Arc<T>)

An owned Arc-ed value

Implementations§

source§

impl<'a, T: ?Sized> CowArc<'a, T>
where &'a T: Into<Arc<T>>,

source

pub fn into_owned(self) -> CowArc<'static, T>

Converts this into an “owned” value. If internally a value is borrowed, it will be cloned into an “owned Arc”. If it is already a CowArc::Owned or a CowArc::Static, it will remain unchanged.

source

pub fn clone_owned(&self) -> CowArc<'static, T>

Clones into an owned [CowArc<'static>]. If internally a value is borrowed, it will be cloned into an “owned Arc”. If it is already a CowArc::Owned or CowArc::Static, the value will be cloned. This is equivalent to .clone().into_owned().

Trait Implementations§

source§

impl<'a, T: ?Sized> AsRef<T> for CowArc<'a, T>

source§

fn as_ref(&self) -> &T

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

impl<'a, T: ?Sized> Borrow<T> for CowArc<'a, T>

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn clone(&self) -> Self

Returns a copy 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 + ?Sized> Debug for CowArc<'a, T>

source§

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

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

impl Default for CowArc<'static, Path>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Default for CowArc<'static, str>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<'a, T: ?Sized> Deref for CowArc<'a, T>

§

type Target = T

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<'a, T: Display + ?Sized> Display for CowArc<'a, T>

source§

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

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

impl<'a> From<&'a String> for CowArc<'a, str>

source§

fn from(value: &'a String) -> Self

Converts to this type from the input type.
source§

impl<T: ?Sized> From<&'static T> for CowArc<'static, T>

source§

fn from(value: &'static T) -> Self

Converts to this type from the input type.
source§

impl From<&'static str> for CowArc<'static, Path>

source§

fn from(value: &'static str) -> Self

Converts to this type from the input type.
source§

impl From<PathBuf> for CowArc<'static, Path>

source§

fn from(value: PathBuf) -> Self

Converts to this type from the input type.
source§

impl From<String> for CowArc<'static, str>

source§

fn from(value: String) -> Self

Converts to this type from the input type.
source§

impl<'a, T: Hash + ?Sized> Hash for CowArc<'a, T>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'a, T: Ord + ?Sized> Ord for CowArc<'a, T>

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<'a, T: PartialEq + ?Sized> PartialEq for CowArc<'a, T>

source§

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

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

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.
source§

impl<'a, T: PartialOrd + ?Sized> PartialOrd for CowArc<'a, T>

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl<'a, T: PartialEq + ?Sized> Eq for CowArc<'a, T>

Auto Trait Implementations§

§

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

§

impl<'a, T: ?Sized> Send for CowArc<'a, T>
where T: Send + Sync,

§

impl<'a, T: ?Sized> Sync for CowArc<'a, T>
where T: Send + Sync,

§

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

§

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

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
source§

impl<T> DynEq for T
where T: Any + Eq,

source§

fn as_any(&self) -> &(dyn Any + 'static)

Casts the type to dyn Any.
source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
source§

impl<T> DynHash for T
where T: DynEq + Hash,

source§

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

Casts the type to dyn Any.
source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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,

§

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

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>,

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more