Struct GenerationSequence 

pub struct GenerationSequence { /* private fields */ }

Canonical committed-token sequence and terminal-condition precedence.

Implementations

impl GenerationSequence

pub fn new( max_tokens: usize, eos_token_ids: impl IntoIterator<Item = u32>, ) -> Self

Creates an empty output sequence with a fixed token budget.

pub fn commit( &mut self, token_id: u32, signals: TokenTerminalSignals, ) -> Result<TokenCommit, GenerationError>

Commits one token and applies stop, grammar, EOS, and budget precedence.

pub fn cancel(&mut self) -> bool

Applies cancellation if the sequence has not already terminated.

pub fn observe_cancellation( &mut self, cancellation: &GenerationCancellationToken, ) -> bool

Observes a cooperative token at a submission boundary.

pub fn tokens(&self) -> &[u32]

Committed tokenizer ids in canonical order.

pub fn into_tokens(self) -> Vec<u32>

Consumes the state into committed tokenizer ids.

pub fn remaining(&self) -> usize

Number of remaining token slots.

pub const fn max_tokens(&self) -> usize

Configured output-token budget.

pub const fn finish_reason(&self) -> Option<FinishReason>

Selected terminal reason.

pub const fn is_finished(&self) -> bool

Whether no further token may be committed.

Trait Implementations

impl Clone for GenerationSequence

fn clone(&self) -> GenerationSequence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerationSequence

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

Formats the value using the given formatter.

impl Eq for GenerationSequence

impl PartialEq for GenerationSequence

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GenerationSequence