Struct var_byte_str::VarByteString

pub struct VarByteString { /* fields omitted */ }

The core struct that represent variable byte encoded of gap of string.

See module documentation for more detail

Implementations

impl VarByteString

pub fn buffer_len(&self) -> usize

Return number of bytes of buffer that represent the string

pub fn sign_len(&self) -> usize

Return number of bit of sign that represent the string

pub fn len(&self) -> usize

pub fn size(&self) -> usize

Return number of bytes this object require to represent the string

pub fn chars(&self) -> Charsⓘ

Important traits for Chars<'a>

impl<'a> Iterator for Chars<'a> type Item = char;

Return an iterator of chars where each iteration return a char primitive converted from this representation.

pub fn gaps(&self) -> Gapsⓘ

Important traits for Gaps<'a>

impl<'a> Iterator for Gaps<'a> type Item = i64;

Return an iterator of gaps where each iteration return a different between current character and previous character. The first iteration always return a code point. It return code point "as is" from original value.

pub fn gaps_bytes(&self) -> GapsBytesⓘ

Important traits for GapsBytes<'a>

impl<'a> Iterator for GapsBytes<'a> type Item = (bool, SmallVec<[u8; 5]>);

Return an iterator of bytes of gap where each iteration return a tuple of bool and SmallVec<[u8; 5]>. The bool part is true when the bytes it represent should be convert to negative value. The SmallVec<[u8; 5]> part contain absolute value of different in least significant byte first order.

Trait Implementations

impl Clone for VarByteString

fn clone(&self) -> VarByteString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VarByteString

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

Formats the value using the given formatter.

impl Display for VarByteString

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

Formats the value using the given formatter.

impl Eq for VarByteString

impl<S> From<S> for VarByteString where
    S: Borrow<str>, 

Add a way to construct this object from any kind of str

fn from(s: S) -> VarByteString

Performs the conversion.

impl Hash for VarByteString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a> Into<String> for &'a VarByteString

Add a way to convert back this object into String

fn into(self) -> String

Performs the conversion.

impl<'a> Into<String> for VarByteString

Add a way to consume this object and turn it into String

fn into(self) -> String

Performs the conversion.

impl<S> PartialEq<S> for VarByteString where
    S: Borrow<str>, 

Allow VarByteString to allow using operator == with &str

fn eq(&self, other: &S) -> bool

It compare with &str by encodes other string into variable gap bytes then compare it to self.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<VarByteString> for VarByteString

fn eq(&self, other: &VarByteString) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &VarByteString) -> bool

This method tests for !=.

impl<S> PartialOrd<S> for VarByteString where
    S: Borrow<str>, 

Allow VarByteString to be comparable with &str

fn partial_cmp(&self, other: &S) -> Option<Ordering>

It compare by encode other as &str into variable gap bytes and compare based on sign and bytes

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for VarByteString

impl StructuralPartialEq for VarByteString