Struct sway_parse::Parser
source · pub struct Parser<'a, 'e> { /* private fields */ }
Implementations§
source§impl<'a, 'e> Parser<'a, 'e>
impl<'a, 'e> Parser<'a, 'e>
pub fn new( handler: &'e Handler, token_stream: &'a TokenStream ) -> Parser<'a, 'e>
pub fn emit_error(&mut self, kind: ParseErrorKind) -> ErrorEmitted
pub fn emit_error_with_span( &mut self, kind: ParseErrorKind, span: Span ) -> ErrorEmitted
sourcepub fn take<P: Peek>(&mut self) -> Option<P>
pub fn take<P: Peek>(&mut self) -> Option<P>
Eats a P
in its canonical way by peeking.
Unlike Parser::peek
, this method advances the parser on success, but not on failure.
sourcepub fn peek<P: Peek>(&self) -> Option<P>
pub fn peek<P: Peek>(&self) -> Option<P>
Tries to peek a P
in its canonical way.
Either way, on success or failure, the parser is not advanced.
sourcepub fn call_parsing_function_with_recovery<'original, T, F: FnOnce(&mut Parser<'a, '_>) -> Result<T, ErrorEmitted>>(
&'original mut self,
parsing_function: F
) -> Result<T, ParseRecoveryStrategies<'original, 'a, 'e>>
pub fn call_parsing_function_with_recovery<'original, T, F: FnOnce(&mut Parser<'a, '_>) -> Result<T, ErrorEmitted>>( &'original mut self, parsing_function: F ) -> Result<T, ParseRecoveryStrategies<'original, 'a, 'e>>
This function will fork the current parse, and call the parsing function. If it succeeds it will sync the original parser with the forked one;
If it fails it will return a Recoverer
together with the ErrorEmited
.
This recoverer can be used to put the forked parsed back in track and then sync the original parser to allow the parsing to continue.
sourcepub fn parse_with_recovery<'original, T: Parse>(
&'original mut self
) -> Result<T, ParseRecoveryStrategies<'original, 'a, 'e>>
pub fn parse_with_recovery<'original, T: Parse>( &'original mut self ) -> Result<T, ParseRecoveryStrategies<'original, 'a, 'e>>
This function will fork the current parse, and try to parse T using the fork. If it succeeds it will sync the original parser with the forked one;
If it fails it will return a Recoverer
together with the ErrorEmited
.
This recoverer can be used to put the forked parsed back in track and then sync the original parser to allow the parsing to continue.
sourcepub fn guarded_parse_with_recovery<'original, P: Peek, T: Parse>(
&'original mut self
) -> Result<Option<T>, ParseRecoveryStrategies<'original, 'a, 'e>>
pub fn guarded_parse_with_recovery<'original, P: Peek, T: Parse>( &'original mut self ) -> Result<Option<T>, ParseRecoveryStrategies<'original, 'a, 'e>>
This function does three things
1 - it peeks P;
2 - it forks the current parser and tries to parse
T using this fork. If it succeeds it syncs the original
parser with the forked one;
3 - if it fails it will return a Recoverer
together with the ErrorEmited
.
This recoverer can be used to put the forked parsed back in track and then sync the original parser to allow the parsing to continue.
sourcepub fn try_parse<T: Parse>(
&mut self,
append_diagnostics: bool
) -> Result<T, ErrorEmitted>
pub fn try_parse<T: Parse>( &mut self, append_diagnostics: bool ) -> Result<T, ErrorEmitted>
Parses a T
in its canonical way.
Do not advance the parser on failure
sourcepub fn parse<T: Parse>(&mut self) -> Result<T, ErrorEmitted>
pub fn parse<T: Parse>(&mut self) -> Result<T, ErrorEmitted>
Parses a T
in its canonical way.
sourcepub fn guarded_parse<G: Peek, T: Parse>(
&mut self
) -> Result<Option<T>, ErrorEmitted>
pub fn guarded_parse<G: Peek, T: Parse>( &mut self ) -> Result<Option<T>, ErrorEmitted>
Parses T
given that the guard G
was successfully peeked.
Useful to parse e.g., $keyword $stuff
as a unit where $keyword
is your guard.
pub fn parse_to_end<T: ParseToEnd>( self ) -> Result<(T, ParserConsumed<'a>), ErrorEmitted>
pub fn try_parse_to_end<T: Parse>( self ) -> Result<Option<(T, ParserConsumed<'a>)>, ErrorEmitted>
pub fn enter_delimited( &mut self, expected_delimiter: Delimiter ) -> Option<(Parser<'_, '_>, Span)>
pub fn is_empty(&self) -> bool
pub fn check_empty(&self) -> Option<ParserConsumed<'a>>
pub fn debug_tokens(&self) -> &[TokenTree]
sourcepub fn ban_visibility_qualifier(
&mut self,
vis: &Option<PubToken>
) -> Result<(), ErrorEmitted>
pub fn ban_visibility_qualifier( &mut self, vis: &Option<PubToken> ) -> Result<(), ErrorEmitted>
Errors given Some(PubToken)
.
pub fn full_span(&self) -> &Span
sourcepub fn consume_while_line_equals(&mut self, line: usize)
pub fn consume_while_line_equals(&mut self, line: usize)
Consume tokens while its line equals to line
.
Warning
To calculate lines the original source code needs to be transversed.
pub fn has_errors(&self) -> bool
pub fn has_warnings(&self) -> bool
Auto Trait Implementations§
impl<'a, 'e> !RefUnwindSafe for Parser<'a, 'e>
impl<'a, 'e> !Send for Parser<'a, 'e>
impl<'a, 'e> !Sync for Parser<'a, 'e>
impl<'a, 'e> Unpin for Parser<'a, 'e>
impl<'a, 'e> !UnwindSafe for Parser<'a, 'e>
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
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.§impl<T> StorageAsMut for T
impl<T> StorageAsMut for T
fn storage<Type>(&mut self) -> StorageMut<'_, Self, Type>where Type: Mappable,
fn storage_as_mut<Type>(&mut self) -> StorageMut<'_, Self, Type>where Type: Mappable,
§impl<T> StorageAsRef for T
impl<T> StorageAsRef for T
fn storage<Type>(&self) -> StorageRef<'_, Self, Type>where Type: Mappable,
fn storage_as_ref<Type>(&self) -> StorageRef<'_, Self, Type>where Type: Mappable,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.