Struct proc_macro_kwargs::parse::NestedList

pub struct NestedList<T: MacroArg, P = Comma> {
    pub brackets: Bracket,
    pub elements: Punctuated<T, P>,
}

A nested list of Punctuated items, surrounded by brackets (ex. [1, 2, 3])

By default, the separator token is the comma ,

Fields

brackets: Bracket

The brackets tokens

elements: Punctuated<T, P>

The list of elements, including punctuation

Methods from Deref<Target = Punctuated<T, P>>

pub fn is_empty(&self) -> bool

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

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.

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

Borrows the first element in this sequence.

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

Mutably borrows the first element in this sequence.

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

Borrows the last element in this sequence.

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

Mutably borrows the last element in this sequence.

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

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

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

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

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

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

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

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

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.

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.

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

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

pub fn trailing_punct(&self) -> bool

Determines whether this punctuated sequence ends with a trailing punctuation.

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

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.

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.

pub fn clear(&mut self)

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

Trait Implementations

impl<T: Debug + MacroArg, P: Debug> Debug for NestedList<T, P>

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

Formats the value using the given formatter.

impl<T: MacroArg, P> Default for NestedList<T, P>

fn default() -> Self

Returns the “default value” for a type.

impl<T: MacroArg, P> Deref for NestedList<T, P>

type Target = Punctuated<T, P>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: MacroArg, P> DerefMut for NestedList<T, P>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: MacroArg, P: Default> From<Vec<T, Global>> for NestedList<T, P>

fn from(v: Vec<T>) -> Self

Performs the conversion.

impl<T: MacroArg, P: Default> FromIterator<T> for NestedList<T, P>

fn from_iter<A: IntoIterator<Item = T>>(iter: A) -> Self

Creates a value from an iterator.

impl<T: Hash + MacroArg, P: Hash> Hash for NestedList<T, P>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T, P> MacroArg for NestedList<T, P> where
    T: MacroArg,
    P: Parse, 

fn parse_macro_arg(stream: ParseStream<'_>) -> Result<Self>

Parse the argument to the macro

impl<T: MacroArg, P: Parse> Parse for NestedList<T, P>

fn parse(stream: ParseStream<'_>) -> Result<Self>

impl<T: PartialEq + MacroArg, P: PartialEq> PartialEq<NestedList<T, P>> for NestedList<T, P>

fn eq(&self, other: &NestedList<T, P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &NestedList<T, P>) -> bool

This method tests for !=.

impl<T: Eq + MacroArg, P: Eq> Eq for NestedList<T, P>

impl<T: MacroArg, P> StructuralEq for NestedList<T, P>

impl<T: MacroArg, P> StructuralPartialEq for NestedList<T, P>