Struct SharedString 

pub struct SharedString<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 shared 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 SharedString::as_c_str() method.

Implementations

impl<TAllocator: Allocator> SharedString<TAllocator>

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

where TAllocator: Default,

Creates a new, empty SharedString.

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

Errors

For details see SharedStringError.

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

where TAllocator: Default,

Creates a new SharedString out of passed string slice.

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

Errors

For details see SharedStringError.

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

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

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

Errors

For details see SharedStringError.

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

Creates a new, empty SharedString with a given allocator.

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

Errors

For details see SharedStringError.

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 SharedString::as_str call.

pub fn length(&self) -> Length

The length of the string.

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

Creates a new WeakSharedString 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<WeakSharedString<TAllocator>>

Abandons current SharedString.

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

Trait Implementations

impl<TAllocator: Allocator> AsRef<str> for SharedString<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 SharedString<TAllocator>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<TAllocator: Allocator> Clone for SharedString<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 SharedString<TAllocator>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

impl<TAllocator> From<&str> for SharedString<TAllocator>

where TAllocator: Default + Allocator,

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<TAllocator: Allocator> Hash for SharedString<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 SharedString<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> ReprC for SharedString<TAllocator>

where TAllocator: ReprC + Allocator,

const CHECK: ()

This field is used for const checks only.

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

type Error = MaxReferencesExceededError

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

Tries to clone the type.