HiddenState

Struct HiddenState 

Source
pub struct HiddenState<T>(pub T)
where
    T: Default;
Expand description

Sometimes one want to compose types or create structures for unsynn that have members that are not part of the parsed syntax but add some additional information. This struct can be used to hold such members while still using the Parser and ToTokens trait implementations automatically generated by the [unsynn!{}] macro or composition syntax. HiddenState will not consume any tokens when parsing and will not emit any tokens when generating a TokenStream. On parsing it is initialized with a default value. It has Deref and DerefMut implemented to access the inner value.

Tuple Fields§

§0: T

Trait Implementations§

Source§

impl<T> Clone for HiddenState<T>
where T: Clone + Default,

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for HiddenState<T>
where T: Default + Debug,

Source§

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

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

impl<T> Default for HiddenState<T>
where T: Default,

Source§

fn default() -> HiddenState<T>

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

impl<T> Deref for HiddenState<T>
where T: Default,

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &<HiddenState<T> as Deref>::Target

Dereferences the value.
Source§

impl<T> DerefMut for HiddenState<T>
where T: Default,

Source§

fn deref_mut(&mut self) -> &mut <HiddenState<T> as Deref>::Target

Mutably dereferences the value.
Source§

impl<T> Parser for HiddenState<T>
where T: Default,

Source§

fn parser( _ctokens: &mut ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>, ) -> Result<HiddenState<T>, Error>

The actual parsing function that must be implemented. This mutates the tokens iterator directly. It should not be called from user code except for implementing parsers itself and then only when the rules below are followed. Read more
Source§

impl<T> ToTokens for HiddenState<T>
where T: Default,

Source§

fn to_tokens(&self, _tokens: &mut TokenStream)

Write &self to the given TokenStream.
Source§

fn to_token_iter( &self, ) -> ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>

Convert &self into a TokenIter object.
Source§

fn into_token_iter<'a>( self, ) -> ShadowCountedIter<'a, <TokenStream as IntoIterator>::IntoIter>
where Self: Sized,

Convert self into a TokenIter object.
Source§

fn to_token_stream(&self) -> TokenStream

Convert &self into a TokenStream object.
Source§

fn into_token_stream(self) -> TokenStream
where Self: Sized,

Convert self into a TokenStream object.
Source§

fn tokens_to_string(&self) -> String

Convert &self into a String object. This is mostly used in the test suite to compare the outputs. When the input is a &str then this parses it and returns a normalized String.

Auto Trait Implementations§

§

impl<T> Freeze for HiddenState<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for HiddenState<T>
where T: RefUnwindSafe,

§

impl<T> Send for HiddenState<T>
where T: Send,

§

impl<T> Sync for HiddenState<T>
where T: Sync,

§

impl<T> Unpin for HiddenState<T>
where T: Unpin,

§

impl<T> UnwindSafe for HiddenState<T>
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> 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> Parse for T
where T: Parser,

Source§

fn parse( tokens: &mut ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>, ) -> Result<Self, Error>

This is the user facing API to parse grammatical entities. Calls a parser() within a transaction. Commits changes on success and returns the parsed value. Read more
Source§

fn parse_all( tokens: &mut ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>, ) -> Result<Self, Error>

Exhaustive parsing within a transaction. This is a convenience method that implies a EndOfStream at the end. Thus it will error if parsing is not exhaustive. Read more
Source§

fn parse_with<T>( tokens: &mut ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>, f: impl FnOnce(Self, &mut ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>) -> Result<T, Error>, ) -> Result<T, Error>

Parse a value in a transaction, pass it to a FnOnce(Self, &mut TokenIter) -> Result<T> closure which creates a new result or returns an Error. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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 = 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.