Struct ImmutableString 

pub struct ImmutableString<TAllocator: Allocator> { /* private fields */ }

This struct is a smart pointer around a string. Internally keeps reference counters for both strong and weak references. Cloning the struct is therefore cheap.

NOTE: the immutable string internally keeps one byte more than the specified data. This last byte is always set to \0 and thus the string is suitable to use as a C-style string, by calling ImmutableString::as_c_str() method.

Implementations

impl<TAllocator: Allocator> ImmutableString<TAllocator>

pub fn empty() -> Result<Self, ImmutableStringError>

where TAllocator: Default,

Creates a new, empty ImmutableString.

This function allocates under the hood, since all immutable strings are backed by smart pointer.

Errors

For details see ImmutableStringError.

pub fn from_str_slice(text: &str) -> Result<Self, ImmutableStringError>

where TAllocator: Default,

Creates a new ImmutableString out of passed string slice.

This function allocates under the hood, since all immutable strings are backed by smart pointer. It also copies the input into the output’s buffer.

Errors

For details see ImmutableStringError.

pub fn from_str_slice_and_allocator( text: &str, allocator: TAllocator, ) -> Result<Self, ImmutableStringError>

Creates a new ImmutableString out of passed string slice and allocator.

This function allocates under the hood, since all immutable strings are backed by smart pointer. It also copies the input into the output’s buffer.

Errors

For details see ImmutableStringError.

pub fn empty_with_allocator( allocator: TAllocator, ) -> Result<Self, ImmutableStringError>

Creates a new, empty ImmutableString with a given allocator.

This function allocates under the hood, since all immutable strings are backed by smart pointer.

Errors

For details see ImmutableStringError.

pub fn strong_count(&self) -> u32

pub fn weak_count(&self) -> u32

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

Compares the underlying raw pointers of the two strings.

Useful for determining whether the two strings have the same allocation, not only data.

pub fn as_str(&self) -> &str

Returns the underlying string.

pub fn as_c_str(&self) -> &str

Returns the underlying string as C-string.

Meaning the string has an additional 0 at the end of the buffer. In particular, the C-string returned by this method has length +1 compared to ImmutableString::as_str call.

pub fn length(&self) -> Length

The length of the string.

pub fn downgrade( &self, ) -> Result<WeakImmutableString<TAllocator>, MaxReferencesExceededError>

Creates a new WeakImmutableString out of current.

Errors

Returns MaxReferencesExceededError if the weak reference count is too high. Cannot exceed [osom_lib_arc::consts::MAX_REFERENCES].

pub fn abandon(self) -> Option<WeakImmutableString<TAllocator>>

Abandons current ImmutableString.

This function returns None if the underlying strong reference counter is still positive. Otherwise it returns the final WeakImmutableString reference.

Trait Implementations

impl<TAllocator: Allocator> AsRef<str> for ImmutableString<TAllocator>

fn as_ref(&self) -> &str

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

impl<TAllocator: Allocator> Borrow<str> for ImmutableString<TAllocator>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<TAllocator: Allocator> Clone for ImmutableString<TAllocator>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<TAllocator: Debug + Allocator> Debug for ImmutableString<TAllocator>

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

Formats the value using the given formatter.

impl<'de, TAllocator: Allocator + Default> Deserialize<'de> for ImmutableString<TAllocator>

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TAllocator: Allocator> Display for ImmutableString<TAllocator>

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

Formats the value using the given formatter.

impl<TAllocator: Allocator> Eq for ImmutableString<TAllocator>

impl<TAllocator: Allocator> Hash for ImmutableString<TAllocator>

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

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<TAllocator: Allocator> PartialEq for ImmutableString<TAllocator>

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<TAllocator: Allocator> ReprC for ImmutableString<TAllocator>

const CHECK: ()

This field is used for const checks only.

impl<TAllocator: Allocator> Serialize for ImmutableString<TAllocator>

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<TAllocator: Allocator> TryClone for ImmutableString<TAllocator>

type Error = MaxReferencesExceededError

fn try_clone(&self) -> Result<Self, Self::Error>

Tries to clone the type.