Skip to main content

OpenerScan

Struct OpenerScan 

Source
pub struct OpenerScan { /* private fields */ }
Expand description

The running state that turns is_conditional_opener into a positional decision: the operand-slot countdown and the \ifcsname body.

Feed the control words in document order through Self::visit — the parser in a pre-pass over the token stream, the linter walking COMMAND nodes in preorder.

The state is a running countdown, so whether a word is visited is itself a decision, and the two consumers make it differently on purpose (module doc). The rule is which question the filter answers. Tokens the document does not execute must not be visited at all — the linter withholds the whole span of a \def body, because a \let carried inside one must not arm the countdown for the code after it. Tokens that merely have no node to build are visited and then discarded from the result — the parser does this for expl3 regions, so an in-region \ifcsname still opens and closes its skip window for the words that follow.

Implementations§

Source§

impl OpenerScan

Source

pub fn new() -> Self

A fresh scan, at the start of a document.

Source

pub fn visit(&mut self, name: &str) -> Word

Classify the next control word name (no leading backslash) and advance the state.

Trait Implementations§

Source§

impl Clone for OpenerScan

Source§

fn clone(&self) -> OpenerScan

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OpenerScan

Source§

impl Debug for OpenerScan

Source§

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

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

impl Default for OpenerScan

Source§

fn default() -> OpenerScan

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

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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.