Struct rkyv::std_impl::ArchivedString

#[repr(transparent)]pub struct ArchivedString(_);

An archived String.

Uses ArchivedStringSlice under the hood.

Implementations

impl ArchivedString

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire ArchivedString.

pub fn as_mut_str(&mut self) -> &mut str

Converts an ArchivedString into a mutable string slice.

pub fn str_pin(self: Pin<&mut Self>) -> Pin<&mut str>

Gets the value of this archived string as a pinned mutable reference.

Trait Implementations

impl Borrow<str> for ArchivedString

pub fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<C> CheckBytes<C> for ArchivedString where
    ArchivedStringSlice: CheckBytes<C>, 

type Error = <ArchivedStringSlice as CheckBytes<C>>::Error

The error that may result from validating the type.

pub unsafe fn check_bytes<'a>(
    bytes: *const u8,
    context: &mut C
) -> Result<&'a Self, Self::Error>

Checks whether the given bytes represent a valid value within the given context.

impl Debug for ArchivedString

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

Formats the value using the given formatter.

impl Deref for ArchivedString

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for ArchivedString

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for ArchivedString

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

Formats the value using the given formatter.

impl Eq for ArchivedString

impl Hash for ArchivedString

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

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 Ord for ArchivedString

pub fn cmp(&self, other: &ArchivedString) -> 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<'_> PartialEq<&'_ str> for ArchivedString

pub fn eq(&self, other: &&str) -> 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 PartialEq<ArchivedString> for ArchivedString

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

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

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

This method tests for !=.

impl<'_> PartialEq<ArchivedString> for &'_ str

pub fn eq(&self, other: &ArchivedString) -> 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 PartialEq<ArchivedString> for String

pub fn eq(&self, other: &ArchivedString) -> 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 PartialEq<String> for ArchivedString

pub fn eq(&self, other: &String) -> 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 PartialOrd<ArchivedString> for ArchivedString

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ArchivedString

impl StructuralPartialEq for ArchivedString