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>
impl<T> Clone for HiddenState<T>
Source§fn clone(&self) -> HiddenState<T>
fn clone(&self) -> HiddenState<T>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl<T> Debug for HiddenState<T>
impl<T> Debug for HiddenState<T>
Source§impl<T> Default for HiddenState<T>where
T: Default,
impl<T> Default for HiddenState<T>where
T: Default,
Source§fn default() -> HiddenState<T>
fn default() -> HiddenState<T>
Returns the “default value” for a type. Read more
Source§impl<T> Deref for HiddenState<T>where
T: Default,
impl<T> Deref for HiddenState<T>where
T: Default,
Source§impl<T> DerefMut for HiddenState<T>where
T: Default,
impl<T> DerefMut for HiddenState<T>where
T: Default,
Source§impl<T> Parser for HiddenState<T>where
T: Default,
impl<T> Parser for HiddenState<T>where
T: Default,
Source§fn parser(
_ctokens: &mut ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>,
) -> Result<HiddenState<T>, Error>
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 moreSource§impl<T> ToTokens for HiddenState<T>where
T: Default,
impl<T> ToTokens for HiddenState<T>where
T: Default,
Source§fn to_tokens(&self, _tokens: &mut TokenStream)
fn to_tokens(&self, _tokens: &mut TokenStream)
Write
&self
to the given TokenStream
.Source§fn to_token_iter(
&self,
) -> ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter> ⓘ
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,
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
fn to_token_stream(&self) -> TokenStream
Convert
&self
into a TokenStream
object.Source§fn into_token_stream(self) -> TokenStreamwhere
Self: Sized,
fn into_token_stream(self) -> TokenStreamwhere
Self: Sized,
Convert
self
into a TokenStream
object.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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Parse for Twhere
T: Parser,
impl<T> Parse for Twhere
T: Parser,
Source§fn parse(
tokens: &mut ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>,
) -> Result<Self, Error>
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 moreSource§fn parse_all(
tokens: &mut ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>,
) -> Result<Self, Error>
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 moreSource§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>
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