Struct rel_alloc::string::RelString

#[repr(C)]
pub struct RelString<A: RawRegionalAllocator, B: Basis = DefaultBasis> { /* private fields */ }

A relative counterpart to String.

Implementations

impl<A: RawRegionalAllocator, B: Basis> RelString<A, B>

pub fn allocator(this: Ref<'_, Self>) -> Ref<'_, A>

Returns a reference to the underlying allocator.

pub fn as_bytes(this: Ref<'_, Self>) -> Ref<'_, [u8]>

Returns a bytes slice of this RelString’s contents.

pub fn as_str(this: Ref<'_, Self>) -> Ref<'_, str>

Returns a string slice of the RelString’s contents.

pub unsafe fn as_mut_vec(this: Mut<'_, Self>) -> Mut<'_, RelVec<u8, A, B>>

Returns a mutable reference to the contents of this RelString.

Safety

The returned Mut<'_, RelVec<u8, A, B>> allows writing bytes which are not valid UTF-8. If this constraint is violated, using the original RelString after dropping the Mut may violate memory safety, as other code may assume that RelStrings only contain valid UTF-8.

pub fn as_mut_str(this: Mut<'_, Self>) -> Mut<'_, str>

Returns a mutable string slice of the RelString’s contents.

pub fn capacity(&self) -> usize

Returns this RelString’s capacity, in bytes.

pub fn clear(this: Mut<'_, Self>)

Truncates this RelString, removing all contents.

While this means the String will have a length of zero, it does not affect its capacity.

pub fn len(&self) -> usize

Returns the length of this RelString, in bytes, not chars or graphemes. In other words, it might not be what a human considers the length of the string.

pub fn is_empty(&self) -> bool

Returns whether this RelString is empty.

Trait Implementations

impl<A: RawRegionalAllocator, B: Basis> DebugRaw for RelString<A, B>

fn fmt_raw(this: Ref<'_, Self>, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<A: RawRegionalAllocator, B: Basis> DerefRaw for RelString<A, B>

type Target = str

The resulting type after dereferencing.

fn deref_raw(this: Ref<'_, Self>) -> Ref<'_, Self::Target>

Dereferences the value.

impl<A: RawRegionalAllocator, B: Basis> DisplayRaw for RelString<A, B>

fn fmt_raw(this: Ref<'_, Self>, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<A: RawRegionalAllocator, B: Basis> DropRaw for RelString<A, B>where
    RelVec<u8, A, B>: DropRaw,

unsafe fn drop_raw(this: Mut<'_, Self>)

Drops the value pointed to by this.

impl<A, B, R> Emplace<RelString<A, B>, <R as RegionalAllocator>::Region> for Clone<'_, R>where
    A: DropRaw + RawRegionalAllocator<Region = R::Region>,
    B: Basis,
    R: RelAllocator<A>,

fn emplaced_meta(&self) -> <RelString<A, B> as Pointee>::Metadata

Returns the metadata of the T that this emplaces.

unsafe fn emplace_unsized_unchecked(
    self,
    out: In<Slot<'_, RelString<A, B>>, A::Region>
)

Emplaces a value into a given slot within some memory region.

impl<A: RawRegionalAllocator, B: Basis, __R: Region> Move<__R> for RelString<A, B>where
    Self: DropRaw,
    RelVec<u8, A, B>: Move<__R>,

unsafe fn move_unsized_unchecked(
    this: In<Val<'_, Self>, __R>,
    out: In<Slot<'_, Self>, __R>
)

Moves a value into a given slot within some memory region.

impl<A: RawRegionalAllocator, B: Basis> Portable for RelString<A, B>where
    RelVec<u8, A, B>: Portable,