Struct HybridString 

#[repr(C)]
pub struct HybridString<const N: usize> {
    pub len_dynamic: usize,
    pub storage: HybridStringStorage<N>,
}

HybridString<N> — open.mp’s ABI-stable string: N bytes inline (terminator included), or a heap pointer past that. len_dynamic holds the length shifted left by one, and whether the string is on the heap in bit 0.

Not Copy: a heap string belongs to whoever built it and is freed through the pointer it carries. Structs holding one travel by reference only.

Fields

len_dynamic: usize

storage: HybridStringStorage<N>

Implementations

impl<const N: usize> HybridString<N>

pub fn new(text: &str) -> Option<HybridString<N>>

An inline copy of text, or None when it does not fit in N - 1 bytes. A string built here never owns heap memory, so it needs no drop.

pub fn is_dynamic(&self) -> bool

Whether the bytes live on the heap.

pub fn len(&self) -> usize

The length in bytes, terminator excluded.

pub fn is_empty(&self) -> bool

Whether the string is empty.

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

The bytes, wherever they live.

Safety

A heap string’s pointer must still be live — true of one the server hands over by reference, for as long as the object that holds it.

pub unsafe fn to_string_lossy(&self) -> String

The text, with invalid UTF-8 replaced.

Safety

As for as_bytes.

Trait Implementations

impl<const N: usize> Default for HybridString<N>

fn default() -> HybridString<N>

Returns the “default value” for a type.