Struct syn::punctuated::Punctuated
source · [−]pub struct Punctuated<T, P> { /* private fields */ }
Expand description
A punctuated sequence of syntax tree nodes of type T
separated by
punctuation of type P
.
Refer to the module documentation for details about punctuated sequences.
Implementations
sourceimpl<T, P> Punctuated<T, P>
impl<T, P> Punctuated<T, P>
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Determines whether this punctuated sequence is empty, meaning it contains no syntax tree nodes or punctuation.
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the number of syntax tree nodes in this punctuated sequence.
This is the number of nodes of type T
, not counting the punctuation of
type P
.
sourcepub fn first_mut(&mut self) -> Option<&mut T>
pub fn first_mut(&mut self) -> Option<&mut T>
Mutably borrows the first element in this sequence.
sourcepub fn last_mut(&mut self) -> Option<&mut T>
pub fn last_mut(&mut self) -> Option<&mut T>
Mutably borrows the last element in this sequence.
sourcepub fn iter(&self) -> Iter<'_, T>ⓘNotable traits for Iter<'a, T>impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;
pub fn iter(&self) -> Iter<'_, T>ⓘNotable traits for Iter<'a, T>impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;
Returns an iterator over borrowed syntax tree nodes of type &T
.
sourcepub fn iter_mut(&mut self) -> IterMut<'_, T>ⓘNotable traits for IterMut<'a, T>impl<'a, T> Iterator for IterMut<'a, T> type Item = &'a mut T;
pub fn iter_mut(&mut self) -> IterMut<'_, T>ⓘNotable traits for IterMut<'a, T>impl<'a, T> Iterator for IterMut<'a, T> type Item = &'a mut T;
Returns an iterator over mutably borrowed syntax tree nodes of type
&mut T
.
sourcepub fn pairs(&self) -> Pairs<'_, T, P>ⓘNotable traits for Pairs<'a, T, P>impl<'a, T, P> Iterator for Pairs<'a, T, P> type Item = Pair<&'a T, &'a P>;
pub fn pairs(&self) -> Pairs<'_, T, P>ⓘNotable traits for Pairs<'a, T, P>impl<'a, T, P> Iterator for Pairs<'a, T, P> type Item = Pair<&'a T, &'a P>;
Returns an iterator over the contents of this sequence as borrowed punctuated pairs.
sourcepub fn pairs_mut(&mut self) -> PairsMut<'_, T, P>ⓘNotable traits for PairsMut<'a, T, P>impl<'a, T, P> Iterator for PairsMut<'a, T, P> type Item = Pair<&'a mut T, &'a mut P>;
pub fn pairs_mut(&mut self) -> PairsMut<'_, T, P>ⓘNotable traits for PairsMut<'a, T, P>impl<'a, T, P> Iterator for PairsMut<'a, T, P> type Item = Pair<&'a mut T, &'a mut P>;
Returns an iterator over the contents of this sequence as mutably borrowed punctuated pairs.
sourcepub fn into_pairs(self) -> IntoPairs<T, P>ⓘNotable traits for IntoPairs<T, P>impl<T, P> Iterator for IntoPairs<T, P> type Item = Pair<T, P>;
pub fn into_pairs(self) -> IntoPairs<T, P>ⓘNotable traits for IntoPairs<T, P>impl<T, P> Iterator for IntoPairs<T, P> type Item = Pair<T, P>;
Returns an iterator over the contents of this sequence as owned punctuated pairs.
sourcepub fn push_value(&mut self, value: T)
pub fn push_value(&mut self, value: T)
Appends a syntax tree node onto the end of this punctuated sequence. The sequence must previously have a trailing punctuation.
Use push
instead if the punctuated sequence may or may not already
have trailing punctuation.
Panics
Panics if the sequence does not already have a trailing punctuation when this method is called.
sourcepub fn push_punct(&mut self, punctuation: P)
pub fn push_punct(&mut self, punctuation: P)
Appends a trailing punctuation onto the end of this punctuated sequence. The sequence must be non-empty and must not already have trailing punctuation.
Panics
Panics if the sequence is empty or already has a trailing punctuation.
sourcepub fn pop(&mut self) -> Option<Pair<T, P>>
pub fn pop(&mut self) -> Option<Pair<T, P>>
Removes the last punctuated pair from this sequence, or None
if the
sequence is empty.
sourcepub fn trailing_punct(&self) -> bool
pub fn trailing_punct(&self) -> bool
Determines whether this punctuated sequence ends with a trailing punctuation.
sourcepub fn empty_or_trailing(&self) -> bool
pub fn empty_or_trailing(&self) -> bool
Returns true if either this Punctuated
is empty, or it has a trailing
punctuation.
Equivalent to punctuated.is_empty() || punctuated.trailing_punct()
.
sourcepub fn push(&mut self, value: T) where
P: Default,
pub fn push(&mut self, value: T) where
P: Default,
Appends a syntax tree node onto the end of this punctuated sequence.
If there is not a trailing punctuation in this sequence when this method
is called, the default value of punctuation type P
is inserted before
the given value of type T
.
sourcepub fn insert(&mut self, index: usize, value: T) where
P: Default,
pub fn insert(&mut self, index: usize, value: T) where
P: Default,
Inserts an element at position index
.
Panics
Panics if index
is greater than the number of elements previously in
this punctuated sequence.
sourcepub fn parse_terminated(input: ParseStream<'_>) -> Result<Self> where
T: Parse,
P: Parse,
pub fn parse_terminated(input: ParseStream<'_>) -> Result<Self> where
T: Parse,
P: Parse,
Parses zero or more occurrences of T
separated by punctuation of type
P
, with optional trailing punctuation.
Parsing continues until the end of this parse stream. The entire content
of this parse stream must consist of T
and P
.
This function is available only if Syn is built with the "parsing"
feature.
sourcepub fn parse_terminated_with(
input: ParseStream<'_>,
parser: fn(_: ParseStream<'_>) -> Result<T>
) -> Result<Self> where
P: Parse,
pub fn parse_terminated_with(
input: ParseStream<'_>,
parser: fn(_: ParseStream<'_>) -> Result<T>
) -> Result<Self> where
P: Parse,
Parses zero or more occurrences of T
using the given parse function,
separated by punctuation of type P
, with optional trailing
punctuation.
Like parse_terminated
, the entire content of this stream is expected
to be parsed.
This function is available only if Syn is built with the "parsing"
feature.
sourcepub fn parse_separated_nonempty(input: ParseStream<'_>) -> Result<Self> where
T: Parse,
P: Token + Parse,
pub fn parse_separated_nonempty(input: ParseStream<'_>) -> Result<Self> where
T: Parse,
P: Token + Parse,
Parses one or more occurrences of T
separated by punctuation of type
P
, not accepting trailing punctuation.
Parsing continues as long as punctuation P
is present at the head of
the stream. This method returns upon parsing a T
and observing that it
is not followed by a P
, even if there are remaining tokens in the
stream.
This function is available only if Syn is built with the "parsing"
feature.
sourcepub fn parse_separated_nonempty_with(
input: ParseStream<'_>,
parser: fn(_: ParseStream<'_>) -> Result<T>
) -> Result<Self> where
P: Token + Parse,
pub fn parse_separated_nonempty_with(
input: ParseStream<'_>,
parser: fn(_: ParseStream<'_>) -> Result<T>
) -> Result<Self> where
P: Token + Parse,
Parses one or more occurrences of T
using the given parse function,
separated by punctuation of type P
, not accepting trailing
punctuation.
Like parse_separated_nonempty
, may complete early without parsing
the entire content of this stream.
This function is available only if Syn is built with the "parsing"
feature.
Trait Implementations
sourceimpl<T, P> Clone for Punctuated<T, P> where
T: Clone,
P: Clone,
impl<T, P> Clone for Punctuated<T, P> where
T: Clone,
P: Clone,
sourceimpl<T: Debug, P: Debug> Debug for Punctuated<T, P>
impl<T: Debug, P: Debug> Debug for Punctuated<T, P>
sourceimpl<T, P> Default for Punctuated<T, P>
impl<T, P> Default for Punctuated<T, P>
sourceimpl<T, P> Extend<Pair<T, P>> for Punctuated<T, P>
impl<T, P> Extend<Pair<T, P>> for Punctuated<T, P>
sourcefn extend<I: IntoIterator<Item = Pair<T, P>>>(&mut self, i: I)
fn extend<I: IntoIterator<Item = Pair<T, P>>>(&mut self, i: I)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl<T, P> Extend<T> for Punctuated<T, P> where
P: Default,
impl<T, P> Extend<T> for Punctuated<T, P> where
P: Default,
sourcefn extend<I: IntoIterator<Item = T>>(&mut self, i: I)
fn extend<I: IntoIterator<Item = T>>(&mut self, i: I)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl<T, P> FromIterator<Pair<T, P>> for Punctuated<T, P>
impl<T, P> FromIterator<Pair<T, P>> for Punctuated<T, P>
sourcefn from_iter<I: IntoIterator<Item = Pair<T, P>>>(i: I) -> Self
fn from_iter<I: IntoIterator<Item = Pair<T, P>>>(i: I) -> Self
Creates a value from an iterator. Read more
sourceimpl<T, P> FromIterator<T> for Punctuated<T, P> where
P: Default,
impl<T, P> FromIterator<T> for Punctuated<T, P> where
P: Default,
sourcefn from_iter<I: IntoIterator<Item = T>>(i: I) -> Self
fn from_iter<I: IntoIterator<Item = T>>(i: I) -> Self
Creates a value from an iterator. Read more
sourceimpl<T, P> Hash for Punctuated<T, P> where
T: Hash,
P: Hash,
impl<T, P> Hash for Punctuated<T, P> where
T: Hash,
P: Hash,
sourceimpl<T, P> Index<usize> for Punctuated<T, P>
impl<T, P> Index<usize> for Punctuated<T, P>
sourceimpl<T, P> IndexMut<usize> for Punctuated<T, P>
impl<T, P> IndexMut<usize> for Punctuated<T, P>
sourceimpl<T, P> IntoIterator for Punctuated<T, P>
impl<T, P> IntoIterator for Punctuated<T, P>
sourceimpl<'a, T, P> IntoIterator for &'a Punctuated<T, P>
impl<'a, T, P> IntoIterator for &'a Punctuated<T, P>
sourceimpl<'a, T, P> IntoIterator for &'a mut Punctuated<T, P>
impl<'a, T, P> IntoIterator for &'a mut Punctuated<T, P>
sourceimpl<T, P> PartialEq<Punctuated<T, P>> for Punctuated<T, P> where
T: PartialEq,
P: PartialEq,
impl<T, P> PartialEq<Punctuated<T, P>> for Punctuated<T, P> where
T: PartialEq,
P: PartialEq,
sourceimpl<T, P> ToTokens for Punctuated<T, P> where
T: ToTokens,
P: ToTokens,
impl<T, P> ToTokens for Punctuated<T, P> where
T: ToTokens,
P: ToTokens,
sourcefn to_tokens(&self, tokens: &mut TokenStream)
fn to_tokens(&self, tokens: &mut TokenStream)
Write self
to the given TokenStream
. Read more
sourcefn to_token_stream(&self) -> TokenStream
fn to_token_stream(&self) -> TokenStream
Convert self
directly into a TokenStream
object. Read more
sourcefn into_token_stream(self) -> TokenStream
fn into_token_stream(self) -> TokenStream
Convert self
directly into a TokenStream
object. Read more
impl<T, P> Eq for Punctuated<T, P> where
T: Eq,
P: Eq,
Auto Trait Implementations
impl<T, P> RefUnwindSafe for Punctuated<T, P> where
P: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, P> Send for Punctuated<T, P> where
P: Send,
T: Send,
impl<T, P> Sync for Punctuated<T, P> where
P: Sync,
T: Sync,
impl<T, P> Unpin for Punctuated<T, P> where
P: Unpin,
T: Unpin,
impl<T, P> UnwindSafe for Punctuated<T, P> where
P: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Spanned for T where
T: Spanned + ?Sized,
impl<T> Spanned for T where
T: Spanned + ?Sized,
sourcefn span(&self) -> Span
fn span(&self) -> Span
Returns a Span
covering the complete contents of this syntax tree
node, or Span::call_site()
if this node is empty. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more