Struct swim_c::cstring::CString

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

A nul-terminated array of C chars allocated in a Hold.

Trait Implementations

impl<M: Sync> Sync for CString<M>

impl<M: Send> Send for CString<M>

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

fn new_resident_layout(data: &[u8], _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: &[u8], _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: &[u8], 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> ResidentFromCopy<L, str, M> for CString<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> ResidentAsRef<L, CStr> for CString<M>

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

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 CString<M>

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

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

impl<'b, L1, L2, M> ResidentStow<'b, L1, L2> for CString<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<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentWithCapacity<L, M> for CString<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> ResidentOrd<L> for CString<M>

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

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

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

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

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

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

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentFromEmpty<L, M> for CString<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> ResidentHash<L> for CString<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> ResidentFromCopyUnchecked<L, [u8], M> for CString<M>

fn new_resident_layout(data: &[u8], _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: &[u8], _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: &[u8], 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> ResidentFromCopyUnchecked<L, CStr, M> for CString<M>

fn new_resident_layout(data: &CStr, 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: &CStr, 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: &CStr, 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> ResidentPartialEq<L, L> for CString<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<M> Resident for CString<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<'a, 'b, L: DynamicLease<'a, Data = u8, Meta = BufHeader<M>>, M> ResidentAddAssign<L, &'b str> for CString<M>

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

Adds rhs to the resident of the lease.

impl<L1, L2, M> ResidentClone<L1, L2> for CString<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<'a, 'b, L: DynamicLease<'a, Data = u8, Meta = BufHeader<M>>, M> ResidentAdd<L, &'b str> for CString<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<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentDerefMut<L> for CString<M>

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

Mutably dereferences the resident of the lease.

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

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

Formats the resident of the lease for debugging.

impl<L: Lease<Data = u8, Meta = BufHeader<M>>, M> ResidentPartialOrd<L, L> for CString<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> ResidentDeref<L> for CString<M>

type Target = CStringLease<L, M>

The type the resident dereferences to.

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

Immutably dereferences the resident of the lease.

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