Skip to main content

CapturedInput

Struct CapturedInput 

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

One captured declared input: the top-level token trees, and how many span handles the producer issued.

Implementations§

Source§

impl CapturedInput

Source

pub fn cursor(&self) -> CaptureCursor<'_>

Open a mechanical read cursor over the top-level captured sequence.

Source§

impl CapturedInput

Source

pub fn fragment(&self) -> CapturedFragment<'_>

Borrow this complete captured input as one exact fragment.

Source§

impl CapturedInput

Source

pub fn authored_item(&self) -> Result<AuthoredItem<'_>, AuthoredItemReadRefusal>

Read this declared item boundary into a source-coupled structural lens for one supported item family.

The complete token reading remains available through AuthoredItem::preserved. The lens identifies only the outer item envelope and leaves full Rust legality to Rustc.

§Errors

Returns a typed refusal where the boundary is empty, has no recognized item family or required name, or does not end as one complete item boundary.

Source§

impl CapturedInput

Source

pub fn trees(&self) -> &[CapturedTokenTree]

The top-level trees, in the order they were written.

Source

pub fn len(&self) -> usize

How many top-level trees were captured.

Source

pub fn is_empty(&self) -> bool

Whether nothing at all was captured.

Source

pub const fn issued(&self) -> usize

How many span handles the producer issued; a handle at or past this index names no token.

Source

pub fn canonical_bytes(&self) -> Vec<u8>

The canonical bytes of this capture — what an identity over the declared input is derived from.

Deterministic and independent of span handles, so two captures of one declaration from different producers encode identically.

Trait Implementations§

Source§

impl Clone for CapturedInput

Source§

fn clone(&self) -> CapturedInput

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 Debug for CapturedInput

Source§

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

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

impl Eq for CapturedInput

Source§

impl Hash for CapturedInput

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CapturedInput

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CapturedInput

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, !>

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.