Struct WeakStr

#[repr(C)]
pub struct WeakStr<Alloc: IAlloc = DefaultAllocator> { /* private fields */ }

A weak reference counted boxed string.

Implementations

impl<Alloc: IAlloc> WeakStr<Alloc>

where Struct<WeakSlice<u8, Alloc>>: IStable, WeakSlice<u8, Alloc>: IStable,

pub const fn has_optimal_layout() -> bool

Returns true if the layout for WeakStr is smaller or equal to that Rust would have generated for it.

impl<Alloc: IAlloc> WeakStr<Alloc>

pub fn upgrade(&self) -> Option<ArcStr<Alloc>>

Returns a strong reference if the strong count hasn’t reached 0 yet.

pub fn force_upgrade(&self) -> ArcStr<Alloc>

Returns a strong reference to the string.

If you’re using this, there are probably design issues in your program…

Trait Implementations

impl<Alloc: IAlloc> Clone for WeakStr<Alloc>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Alloc: IAlloc> From<&ArcStr<Alloc>> for WeakStr<Alloc>

fn from(value: &ArcStr<Alloc>) -> Self

Converts to this type from the input type.

impl<Alloc: IAlloc> IStable for WeakStr<Alloc>

where Struct<WeakSlice<u8, Alloc>>: IStable, WeakSlice<u8, Alloc>: IStable,

const REPORT: &'static TypeReport

A compile-time generated report of the fields of the type, allowing for compatibility inspection.

const ID: u64

A stable (and ideally unique) identifier for the type. Often generated using crate::report::gen_id, but can be manually set.

type ForbiddenValues = <Struct<WeakSlice<u8, Alloc>> as IStable>::ForbiddenValues

The values that the annotated type cannot occupy.

type UnusedBits = <Struct<WeakSlice<u8, Alloc>> as IStable>::UnusedBits

The padding bits in the annotated types

type Size = <Struct<WeakSlice<u8, Alloc>> as IStable>::Size

The size of the annotated type in bytes.

type Align = <Struct<WeakSlice<u8, Alloc>> as IStable>::Align

The alignment of the annotated type in bytes.

type HasExactlyOneNiche = <Struct<WeakSlice<u8, Alloc>> as IStable>::HasExactlyOneNiche

Allows the detection of whether or not core::option::Options are stable:

type ContainsIndirections = <Struct<WeakSlice<u8, Alloc>> as IStable>::ContainsIndirections

Whether or not the type contains indirections (pointers, indices in independent data-structures…)

fn size() -> usize

Returns the size of the type.

fn align() -> usize

Returns the alignment of the type.

unsafe fn is_invalid(ptr: *const u8) -> bool

Returns true if ptr points to memory that cannot be a valid value of Self.