Type Alias FosterByteStr

pub type FosterByteStr = Foster<Box<ByteStr>, &'static str>;

Foster for ByteStr.

Supports IntoOwned, HasLength, AsRef<str>, Eq/PartialEq, Ord/PartialOrd, Hash, and Display.

Note that we need to wrap ByteStr in a Box because ByteStr has interior mutability and thus cannot be placed as is in a constant.

Aliased Type

enum FosterByteStr {
    Owned(Box<ByteStr>),
    Fostered(&'static str),
}

Variants

Owned(Box<ByteStr>)

Owned.

Fostered(&'static str)

Fostered.

Trait Implementations

impl AsRef<str> for FosterByteStr

fn as_ref(&self) -> &str

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

impl Display for FosterByteStr

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

Formats the value using the given formatter.

impl From<&str> for FosterByteStr

fn from(string: &str) -> Self

Converts to this type from the input type.

impl HasLength for FosterByteStr

fn len(&self) -> usize

Length.

impl Hash for FosterByteStr

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

where HasherT: 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 IntoOwned for FosterByteStr

fn into_owned(self) -> Self

Into owned.

impl Ord for FosterByteStr

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,

Restrict a value to a certain interval.

impl PartialEq for FosterByteStr

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for FosterByteStr

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for FosterByteStr