Skip to main content

LookaheadBuf

Struct LookaheadBuf 

Source
pub struct LookaheadBuf<T: Copy, const CAP: usize> { /* private fields */ }
Expand description

Fixed-capacity ring buffer for parser lookahead.

Slots are MaybeUninit because the token type is expected to be Copy and the buffer tracks occupancy through head and len. Only head..head + len indices (modulo CAP) are considered initialised at any moment.

CAP must be a power of two; the indexing arithmetic uses a bitmask (& (CAP - 1)) instead of a modulo for speed. A debug-build assertion rejects non-power-of-two capacities during construction.

Implementations§

Source§

impl<T: Copy, const CAP: usize> LookaheadBuf<T, CAP>

Source

pub fn new() -> Self

Create an empty buffer. CAP must be a power of two; violating this in debug builds trips a panic on first use.

§Panics

In debug builds, panics if CAP is not a power of two.

Source

pub fn len(&self) -> usize

Number of tokens currently buffered.

Source

pub fn is_empty(&self) -> bool

Whether the buffer is empty.

Source

pub fn is_full(&self) -> bool

Whether the buffer is full. Callers that rely on the ring never overflowing (no expansion is possible) should check this before pushing.

Source

pub const fn capacity(&self) -> usize

Capacity, identical to the CAP const generic.

Source

pub fn push_back(&mut self, value: T)

Push a token at the back.

Hard-panics on overflow: the ring has no heap fallback and overwriting the oldest slot would silently corrupt the buffer. Callers must size CAP large enough for the deepest lookahead the parser ever performs.

§Panics

Panics if CAP tokens have been pushed without any being consumed.

Source

pub fn pop_front(&mut self) -> Option<T>

Pop the front token, or None if the buffer is empty.

Source

pub fn get(&self, n: usize) -> Option<T>

Copy the nth-ahead token without consuming it (0 = next).

Source

pub fn clear(&mut self)

Discard every buffered token. Leaves the ring ready for reuse.

Trait Implementations§

Source§

impl<T: Copy, const CAP: usize> Debug for LookaheadBuf<T, CAP>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Copy, const CAP: usize> Default for LookaheadBuf<T, CAP>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T, const CAP: usize> Freeze for LookaheadBuf<T, CAP>
where T: Freeze,

§

impl<T, const CAP: usize> RefUnwindSafe for LookaheadBuf<T, CAP>
where T: RefUnwindSafe,

§

impl<T, const CAP: usize> Send for LookaheadBuf<T, CAP>
where T: Send,

§

impl<T, const CAP: usize> Sync for LookaheadBuf<T, CAP>
where T: Sync,

§

impl<T, const CAP: usize> Unpin for LookaheadBuf<T, CAP>
where T: Unpin,

§

impl<T, const CAP: usize> UnsafeUnpin for LookaheadBuf<T, CAP>
where T: UnsafeUnpin,

§

impl<T, const CAP: usize> UnwindSafe for LookaheadBuf<T, CAP>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more