Enum bevy::utils::CowArc

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

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

impl<'a, T> CowArc<'a, T>

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

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.

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

impl<'a, T> AsRef<T> for CowArc<'a, T>

where T: ?Sized,

fn as_ref(&self) -> &T

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

impl<'a, T> Borrow<T> for CowArc<'a, T>

where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

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

where T: ?Sized,

fn clone(&self) -> CowArc<'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 CowArc<'a, T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl Default for CowArc<'static, Path>

fn default() -> CowArc<'static, Path>

Returns the “default value” for a type.

impl Default for CowArc<'static, str>

fn default() -> CowArc<'static, str>

Returns the “default value” for a type.

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

where T: ?Sized,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T> Display for CowArc<'a, T>

where T: Display + ?Sized,

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

Formats the value using the given formatter.

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

fn from(value: &'a String) -> CowArc<'a, str>

Converts to this type from the input type.

impl<T> From<&'static T> for CowArc<'static, T>

where T: ?Sized,

fn from(value: &'static T) -> CowArc<'static, T>

Converts to this type from the input type.

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

fn from(value: &'static str) -> CowArc<'static, Path>

Converts to this type from the input type.

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

fn from(value: PathBuf) -> CowArc<'static, Path>

Converts to this type from the input type.

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

fn from(value: String) -> CowArc<'static, str>

Converts to this type from the input type.

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

where T: Hash + ?Sized,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> Ord for CowArc<'a, T>

where T: Ord + ?Sized,

fn cmp(&self, other: &CowArc<'a, T>) -> 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> PartialEq for CowArc<'a, T>

where T: PartialEq + ?Sized,

fn eq(&self, other: &CowArc<'a, T>) -> 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> PartialOrd for CowArc<'a, T>

where T: PartialOrd + ?Sized,

fn partial_cmp(&self, other: &CowArc<'a, T>) -> 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> Eq for CowArc<'a, T>

where T: PartialEq + ?Sized,