Struct toad_common::cursor::Cursor

pub struct Cursor<T> { /* private fields */ }

A cursor over a byte array (std- and alloc-less port of std::io::Cursor)

Implementations

impl<T: AsRef<[u8]>> Cursor<T>

pub fn new(t: T) -> Cursor<T>

Creates a new cursor

pub fn into_inner(self) -> T

Unwraps the cursor, discarding its internal position

pub fn next(&mut self) -> Option<u8>

Take the next byte in the cursor, returning None if the cursor is exhausted.

Runs in O(1) time.

pub fn take(&mut self, n: usize) -> &[u8]

Take n bytes from the cursor, stopping early if the end of the buffer is encountered.

Runs in O(1) time.

pub fn take_exact(&mut self, n: usize) -> Option<&[u8]>

Take n bytes from the cursor, returning None if the end of the buffer is encountered.

Runs in O(1) time.

pub fn peek(&self, n: usize) -> &[u8]

Without advancing the position, look at the next n bytes, or until the end if there are less than n bytes remaining.

Runs in O(1) time.

pub fn peek_exact(&self, n: usize) -> Option<&[u8]>

Without advancing the position, look at the next n bytes, returning None if there are less than n bytes remaining.

Runs in O(1) time.

pub fn skip(&mut self, n: usize) -> usize

Advance the cursor by n bytes.

Returns the actual number of bytes skipped:

• Equal to n if there are at least n more bytes in the buffer
• Less than n if n would seek past the end
• Zero if the cursor is already exhausted

Runs in O(1) time.

pub fn take_while(&mut self, f: impl FnMut(u8) -> bool) -> &[u8]

Consume bytes until a predicate returns false.

Runs in O(n) time.

pub fn is_exhausted(&self) -> bool

Whether the cursor has reached the end of the buffer.

Runs in O(1) time.

pub fn remaining(&self) -> usize

The number of elements not yet consumed

Runs in O(1) time.

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

Get the bytes remaining in the buffer without advancing the position.

Runs in O(1) time.

pub fn take_until_end(&mut self) -> &[u8]

Get the bytes remaining in the buffer, advancing the position to the end.

Runs in O(1) time.

pub fn position(&self) -> usize

Get the position the cursor points to within the buffer

Trait Implementations

impl<T: Clone> Clone for Cursor<T>

fn clone(&self) -> Cursor<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Cursor<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Cursor<T>

fn default() -> Cursor<T>

Returns the “default value” for a type.

impl<T: Ord> Ord for Cursor<T>

fn cmp(&self, other: &Cursor<T>) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Cursor<T>> for Cursor<T>

fn eq(&self, other: &Cursor<T>) -> bool

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

const 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<T: PartialOrd> PartialOrd<Cursor<T>> for Cursor<T>

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

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

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

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

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

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

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

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

const 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<T: Copy> Copy for Cursor<T>

impl<T: Eq> Eq for Cursor<T>

impl<T> StructuralEq for Cursor<T>

impl<T> StructuralPartialEq for Cursor<T>