Struct blockbuffers::position::StringPosition

pub struct StringPosition(pub usize);

StringPosition wrappers a position which points to a string in the buffer.

Strings are stored as vectors of u8, and it is guaranteed that there will be an extra 0 after the last item. The extra 0 does not count in length.

Example

use blockbuffers::position::StringPosition;

let buf = &[03u8, 0, 0, 0, 'b' as u8, 'b' as u8, 's' as u8, 0][..];
let pos = StringPosition(0);

assert_eq!(3, pos.len(buf));
assert_eq!("bbs", pos.as_str(buf));

Tuple Fields

0: usize

Implementations

impl StringPosition

pub fn len(self, buf: &[u8]) -> usize

Reads the length of the string in bytes.

pub fn as_str(self, buf: &[u8]) -> &str

Gets the reference to the string.

Trait Implementations

impl Clone for StringPosition

fn clone(&self) -> StringPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringPosition

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

Formats the value using the given formatter.

impl PartialEq<StringPosition> for StringPosition

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<StringPosition> for StringPosition

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Copy for StringPosition

impl StructuralPartialEq for StringPosition