Struct LBString

pub struct LBString(/* private fields */);

A Unicode string stored using the Linked Bytes format.

This is more compact than all of the current UTF formats (namely, UTF-1, 7, 8, 16, let alone 32), since no surrogate pairs are used. Instead, the Linked Bytes format is leveraged, with separate codepoints being stored as individual Linked Bytes numbers. Both the link/end bits of the bytes and length of the entire message, either via the null terminator (which still works since a linking 0 has the most significant bit set to 1 and cannot be confused with the null terminator when reinterpreted as u8) or via storing it separately (as Rust Strings do), are available. This means that the UTF-32 number of each codepoint can be encoded using the usual Linked Bytes format, with the link bit cleared in a byte indicating that one character has ended and a new one is coming next.

Usage

Conversion from String or &str:

static MY_STRING: &str = "My string!";
let stdstring = String::from("This is a standard string!");

let my_string_lb = LBString::from(MY_STRING); // Creates an LBString from a string slice
let stdstring_lb = LBString::from(stdstring); // Creates an LBString from a String
let my_string_lb_2 = MY_STRING.chars().collect::<LBString>(); // Creates an LBString from an iterator

Implementations

impl LBString

pub fn chars(&self) -> impl Iterator<Item = char> + '_

Returns an iterator over the codepoints in the string.

This is the core method of this type. Most other methods use this to perform more complex operations, such as conversion from an &str.

pub fn len(&self) -> usize

Counts the number of codepoints stored.

This will iterate through the entire string and count how many codepoints were resolved successfully. Currently, this is implemented as simply self.chars().count().

pub fn is_empty(&self) -> bool

Returns true if there are no codepoints stored, false otherwise.

pub const fn inner(&self) -> &LBSequence

Returns an immutable reference to the underlying sequence.

Trait Implementations

impl Clone for LBString

fn clone(&self) -> LBString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LBString

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for LBString

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> FromIterator<&'a char> for LBString

fn from_iter<I: IntoIterator<Item = &'a char>>(iter: I) -> Self

Convenience implementation for collections which iterate over references to items rather than the items themselves, to avoid repetitive .copied() in calling code.

impl FromIterator<char> for LBString

fn from_iter<I: IntoIterator<Item = char>>(iter: I) -> Self

Creates a value from an iterator.