Union ArchivedStringRepr

#[repr(C)]
pub union ArchivedStringRepr {
    /* private fields */
}

Available on crate feature dep_rkyv only.

An archived string representation that can inline short strings.

Implementations

impl ArchivedStringRepr

pub fn is_inline(&self) -> bool

Returns whether the representation is inline.

pub unsafe fn out_of_line_offset(&self) -> isize

Returns the offset of the representation.

Safety

The internal representation must be out-of-line.

pub fn as_ptr(&self) -> *const u8

Returns a pointer to the bytes of the string.

pub fn as_mut_ptr(this: Seal<'_, ArchivedStringRepr>) -> *mut u8

Returns a mutable pointer to the bytes of the string.

pub fn len(&self) -> usize

Returns the length of the string.

pub fn is_empty(&self) -> bool

Returns whether the string is empty.

pub fn as_str_ptr(&self) -> *const str

Returns a pointer to the string as a str.

pub fn as_bytes(&self) -> &[u8]

Returns a slice of the bytes of the string.

pub fn as_bytes_seal(this: Seal<'_, ArchivedStringRepr>) -> Seal<'_, [u8]>

Returns a mutable slice of the bytes of the string.

pub fn as_str(&self) -> &str

Returns a reference to the string as a str.

pub fn as_str_seal(this: Seal<'_, ArchivedStringRepr>) -> Seal<'_, str>

Returns a mutable reference to the string as a str.

pub unsafe fn emplace_inline(value: &str, out: *mut ArchivedStringRepr)

Emplaces a new inline representation for the given str.

This function is guaranteed not to write any uninitialized bytes to out.

Safety

• The length of value must be less than or equal to INLINE_CAPACITY.
• out must point to a valid location to write the inline representation.

pub unsafe fn try_emplace_out_of_line<E>( value: &str, target: usize, out: Place<ArchivedStringRepr>, ) -> Result<(), E>

where E: Source,

Emplaces a new out-of-line representation for the given str.

Safety

The length of str must be greater than INLINE_CAPACITY and less than or equal to OUT_OF_LINE_CAPACITY.

pub unsafe fn emplace_out_of_line( value: &str, target: usize, out: Place<ArchivedStringRepr>, )

Emplaces a new out-of-line representation for the given str.

Panics

• The offset calculated for the repr does not fit in an isize
• The offset calculated for the repr exceeds the offset storage

Safety

The length of str must be greater than INLINE_CAPACITY and less than or equal to OUT_OF_LINE_CAPACITY.

Trait Implementations

impl<C> CheckBytes<C> for ArchivedStringRepr

where C: Fallible + ?Sized, <C as Fallible>::Error: Source,

unsafe fn check_bytes( value: *const ArchivedStringRepr, _: &mut C, ) -> Result<(), <C as Fallible>::Error>

Checks whether the given pointer points to a valid value within the given context.

impl Portable for ArchivedStringRepr

where OutOfLineRepr: Portable, InlineRepr: Portable,