Struct swim_mem::resident::String

pub struct String<M = ()> { /* fields omitted */ }

A resizeable array of Unicode code points, residing in a memory Lease. A String is a Resident typeclass; it doesn't store any data in its internal structure. Rather, String implements an access pattern for memory blocks managed by a Lease. A composing Lease type defines the memory allocation and ownership semantics of the composed String type.

Lease implementations commonly composed with a String include:

• Own<String>: the exclusive owner of a relocatable, resizeable string.
• Mut<String>: a mutably dereferenceable strong owner of an unrelocatable, resizeable string.
• Ref<String>: an immutably dereferenceable strong owner of an unrelocatable, resizeable string.
• Hard<String>: an undereferenceable strong owner of a relocatable string.
• Soft<String>: an undereferenceable weak owner of a relocatable string.

String implements LeaseDeref, and LeaseDerefMut, which enables deref coercions from Own<String>, Mut<String>, and Ref<String> to &StringLease<L>. StringLease in turn deref coerces to &str and &mut str. This makes leased strings "feel" like they contain a str, even though String is just a typeclass for accessing the str stored in the composing memory Lease. Most string operations are defined on StringLease; String can't do much on its own since it doesn't actually contain any data.

Trait Implementations

impl<M> Resident for String<M>

type Data = u8

The type of pointed-to data stored in leased memory blocks. The size of leased memory blocks must be a positive multiple of the Data size.

type Meta = BufHeader<M>

The type of metadata stored with leased memory blocks. Meta data must contain sufficient information to resolve the size of any resided-in memory Lease.

unsafe fn resident_size(_data: *mut u8, meta: *mut BufHeader<M>) -> usize

Returns the size in bytes of the Resident with the given data and meta data.

unsafe fn resident_drop(_data: *mut u8, _meta: *mut BufHeader<M>)

Drops the Resident with the given data and meta data.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentFromCopy<L, str, M> for String<M>

fn new_resident_layout(data: &str, _meta: &M) -> Layout

Returns the memory layout for a resident with a copy of the given data and meta data.

fn new_resident_ptr(raw: *mut u8, _data: &str, _meta: &M) -> *mut u8

Converts a raw pointer into a Data pointer for a resident with a copy of the given data and meta data.

fn new_resident(lease: &mut L, data: &str, meta: M)

Initializes the lease with a resident from a copy of the given data and meta data.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentFromEmpty<L, M> for String<M>

fn new_resident_layout(_meta: &M) -> Layout

Returns the memory layout for an empty resident with the given meta data.

fn new_resident_ptr(raw: *mut u8, _meta: &M) -> *mut u8

Converts a raw pointer into a Data pointer for an empty resident with the given meta data.

fn new_resident(lease: &mut L, meta: M)

Initializes the lease with an empty resident from the given meta data.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentWithCapacity<L, M> for String<M>

fn new_resident_layout(cap: usize, _meta: &M) -> Result<Layout, LayoutError>

Returns the memory layout for an empty resident with the given pre-allocated capacity and meta data.

fn new_resident_ptr(raw: *mut u8, _cap: usize, _meta: &M) -> *mut u8

Converts a raw pointer into a Data pointer for an empty resident with the given preallocated capacity and meta data.

fn new_resident(lease: &mut L, cap: usize, meta: M)

Initializes the lease with an empty resident from the given pre-allocated capacity and meta data.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentDeref<L> for String<M>

type Target = StringLease<L, M>

The type the resident dereferences to.

fn resident_deref(lease: &L) -> &StringLease<L, M>

Immutably dereferences the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentDerefMut<L> for String<M>

fn resident_deref_mut(lease: &mut L) -> &mut StringLease<L, M>

Mutably dereferences the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentAsRef<L, str> for String<M>

fn resident_as_ref(lease: &L) -> &str

Returns the resident of the lease as an immutable reference to type T.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentAsRef<L, [u8]> for String<M>

fn resident_as_ref(lease: &L) -> &[u8]

Returns the resident of the lease as an immutable reference to type T.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndex<L, Range<usize>> for String<M>

type Output = str

The type of values indexed by the resident for the parameterized Idx type.

fn resident_index(lease: &L, index: Range<usize>) -> &str

Returns an immutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndex<L, RangeFrom<usize>> for String<M>

type Output = str

The type of values indexed by the resident for the parameterized Idx type.

fn resident_index(lease: &L, index: RangeFrom<usize>) -> &str

Returns an immutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndex<L, RangeFull> for String<M>

type Output = str

The type of values indexed by the resident for the parameterized Idx type.

fn resident_index(lease: &L, index: RangeFull) -> &str

Returns an immutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndex<L, RangeInclusive<usize>> for String<M>

type Output = str

The type of values indexed by the resident for the parameterized Idx type.

fn resident_index(lease: &L, index: RangeInclusive<usize>) -> &str

Returns an immutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndex<L, RangeTo<usize>> for String<M>

type Output = str

The type of values indexed by the resident for the parameterized Idx type.

fn resident_index(lease: &L, index: RangeTo<usize>) -> &str

Returns an immutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndex<L, RangeToInclusive<usize>> for String<M>

type Output = str

The type of values indexed by the resident for the parameterized Idx type.

fn resident_index(lease: &L, index: RangeToInclusive<usize>) -> &str

Returns an immutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndexMut<L, Range<usize>> for String<M>

fn resident_index_mut(lease: &mut L, index: Range<usize>) -> &mut str

Returns a mutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndexMut<L, RangeFrom<usize>> for String<M>

fn resident_index_mut(lease: &mut L, index: RangeFrom<usize>) -> &mut str

Returns a mutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndexMut<L, RangeFull> for String<M>

fn resident_index_mut(lease: &mut L, index: RangeFull) -> &mut str

Returns a mutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndexMut<L, RangeInclusive<usize>> for String<M>

fn resident_index_mut(lease: &mut L, index: RangeInclusive<usize>) -> &mut str

Returns a mutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndexMut<L, RangeTo<usize>> for String<M>

fn resident_index_mut(lease: &mut L, index: RangeTo<usize>) -> &mut str

Returns a mutable reference to the value at the given index of the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentIndexMut<L, RangeToInclusive<usize>> for String<M>

fn resident_index_mut(lease: &mut L, index: RangeToInclusive<usize>) -> &mut str

Returns a mutable reference to the value at the given index of the resident of the lease.

impl<'a, 'b, L: DynamicLease<'a, Data = u8, Meta = BufHeader<M>>, M> ResidentAdd<L, &'b str> for String<M>

type Output = L

The resulting type of applying the + operator.

fn resident_add(lease: L, rhs: &'b str) -> L

Returns the addition of rhs to the resident of the lease.

impl<'a, 'b, L: DynamicLease<'a, Data = u8, Meta = BufHeader<M>>, M> ResidentAddAssign<L, &'b str> for String<M>

fn resident_add_assign(lease: &mut L, rhs: &'b str)

Adds rhs to the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentPartialEq<L, L> for String<M>

fn resident_eq(lease: &L, other: &L) -> bool

Returns true if the resident of the lease equals some other value.

fn resident_ne(lease: &L, other: &L) -> bool

Returns false if the resident of the lease equals some other value.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentEq<L> for String<M>

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentPartialOrd<L, L> for String<M>

fn resident_partial_cmp(lease: &L, other: &L) -> Option<Ordering>

Returns the ordering of the resident of the lease relative to some other value, if comparable.

fn resident_lt(lease: &L, other: &L) -> bool

Returns true if the resident of the lease orders before some other value.

fn resident_le(lease: &L, other: &L) -> bool

Returns true if the resident of the lease orders before or the same as some other value.

fn resident_ge(lease: &L, other: &L) -> bool

Returns true if the resident of the lease orders the same as or after some other value.

fn resident_gt(lease: &L, other: &L) -> bool

Returns true if the resident of the lease orders after some other value.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentOrd<L> for String<M>

fn resident_cmp(lease: &L, other: &L) -> Ordering

Returns the relative ordering of the residents occupying the given leases.

fn resident_lt(lease: &L, other: &L) -> bool

fn resident_le(lease: &L, other: &L) -> bool

fn resident_ge(lease: &L, other: &L) -> bool

fn resident_gt(lease: &L, other: &L) -> bool

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentHash<L> for String<M>

fn resident_hash<H: Hasher>(lease: &L, state: &mut H)

Hashes the resident of the lease.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentDisplay<L> for String<M>

fn resident_fmt(lease: &L, f: &mut Formatter) -> Result

Formats the resident of the lease for display.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentDebug<L> for String<M>

fn resident_fmt(lease: &L, f: &mut Formatter) -> Result

Formats the resident of the lease for debugging.

impl<L1, L2, M> ResidentClone<L1, L2> for String<M> where
    L1: Lease<Data = u8, Meta = BufHeader<M>>,
    L2: Lease<Data = u8, Meta = BufHeader<M>>,
    M: TryClone, 

fn new_resident_layout(lease: &L1) -> Layout

Returns the preferred memory layout of a clone destination for the resident of the lease.

fn resident_clone(src: &L1, dst: &mut L2) -> Result<(), HoldError>

Clones the resident of the src lease into the dst lease.

impl<'b, L1, L2, M> ResidentStow<'b, L1, L2> for String<M> where
    L1: Lease<Data = u8, Meta = BufHeader<M>>,
    L2: Lease<Data = u8, Meta = BufHeader<M>>,
    M: TryClone, 

fn new_resident_layout(lease: &L1) -> Layout

Returns the preferred memory layout of a move destination for the resident of the lease.

unsafe fn resident_stow(
    src: &mut L1,
    dst: &mut L2,
    _hold: &dyn Hold<'b>
) -> Result<(), HoldError>

Relocates the resident from the src lease to the dst lease. Leaves the src lase in its original state on failure.

unsafe fn resident_unstow(_src: &mut L1, _dst: &mut L2)

Reverts the most recent resident_stow operation by relocating the resident of the dst lease back to the src lease.

impl<M: Sync> Sync for String<M>

impl<M: Send> Send for String<M>