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§

source §

impl<T, P> Punctuated<T, P>

source

pub const fn new() -> Self

Creates an empty punctuated sequence.

source

pub fn is_empty(&self) -> bool

Determines whether this punctuated sequence is empty, meaning it contains no syntax tree nodes or punctuation.

source

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.

source

pub fn first(&self) -> Option<&T>

Borrows the first element in this sequence.

source

pub fn first_mut(&mut self) -> Option<&mut T>

Mutably borrows the first element in this sequence.

source

pub fn last(&self) -> Option<&T>

Borrows the last element in this sequence.

source

pub fn last_mut(&mut self) -> Option<&mut T>

Mutably borrows the last element in this sequence.

source

pub fn iter(&self) -> Iter<'_, T> ⓘ

Returns an iterator over borrowed syntax tree nodes of type &T.

source

pub fn iter_mut(&mut self) -> IterMut<'_, T> ⓘ

Returns an iterator over mutably borrowed syntax tree nodes of type &mut T.

source

pub fn pairs(&self) -> Pairs<'_, T, P> ⓘ

Returns an iterator over the contents of this sequence as borrowed punctuated pairs.

source

pub fn pairs_mut(&mut self) -> PairsMut<'_, T, P> ⓘ

Returns an iterator over the contents of this sequence as mutably borrowed punctuated pairs.

source

pub fn into_pairs(self) -> IntoPairs<T, P> ⓘ

Returns an iterator over the contents of this sequence as owned punctuated pairs.

source

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.

source

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.

source

pub fn pop(&mut self) -> Option<Pair<T, P>>

Removes the last punctuated pair from this sequence, or None if the sequence is empty.

source

pub fn trailing_punct(&self) -> bool

Determines whether this punctuated sequence ends with a trailing punctuation.

source

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().

source

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.

source

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.

source

pub fn clear(&mut self)

Clears the sequence of all values and punctuation, making it empty.

source

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.

source

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.

source

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.

source