Struct full_moon::ast::punctuated::Punctuated

pub struct Punctuated<'a, T> { /* fields omitted */ }

A punctuated sequence of node T separated by TokenReference. Refer to the module documentation for more details.

Implementations

impl<'a, T> Punctuated<'a, T>

pub fn new() -> Self

Creates an empty punctuated sequence

let mut punctuated: Punctuated<i32> = Punctuated::new();

pub fn is_empty(&self) -> bool

Returns whether there's any nodes in the punctuated sequence

let mut punctuated = Punctuated::new();
assert!(punctuated.is_empty());
punctuated.push(Pair::new((), None));
assert!(!punctuated.is_empty());

pub fn len(&self) -> usize

Returns the number of pairs in the punctuated sequence

let mut punctuated = Punctuated::new();
assert_eq!(punctuated.len(), 0);
punctuated.push(Pair::new((), None));
assert_eq!(punctuated.len(), 1);

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

Important traits for Iter<'a, 'b, T>

impl<'a, 'b, T> Iterator for Iter<'a, 'b, T> type Item = &'b T;

Returns an iterator over references of the sequence values, ignoring punctuation

let mut punctuated = Punctuated::new();
punctuated.push(Pair::new(1, None));
let mut iterator = punctuated.iter();
assert_eq!(iterator.next(), Some(&1));
assert_eq!(iterator.next(), None);

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

Important traits for IterMut<'a, 'b, T>

impl<'a, 'b, T> Iterator for IterMut<'a, 'b, T> type Item = &'b mut T;

Returns an iterator over mutable references of the sequence values, ignoring punctuation

let mut punctuated = Punctuated::new();
punctuated.push(Pair::new(1, None));
for item in punctuated.iter_mut() {
    *item += 1;
}
assert_eq!(punctuated.pop(), Some(Pair::new(2, None)));

pub fn into_pairs(self) -> impl Iterator<Item = Pair<'a, T>>

Returns an iterator over the Pair sequences

let mut punctuated = Punctuated::new();
punctuated.push(Pair::new(1, None));
let mut iterator = punctuated.into_pairs();
assert_eq!(iterator.next(), Some(Pair::new(1, None)));
assert_eq!(iterator.next(), None);

pub fn last(&self) -> Option<&Pair<'a, T>>

Returns the last Pair in the sequence

let mut punctuated = Punctuated::new();
punctuated.push(Pair::new(1, None));
assert_eq!(punctuated.last(), Some(&Pair::new(1, None)));

pub fn pairs(&self) -> impl Iterator<Item = &Pair<'a, T>>

Returns an iterator over the Pair sequences as references

let mut punctuated = Punctuated::new();
punctuated.push(Pair::new(1, None));
let mut iterator = punctuated.pairs();
assert_eq!(iterator.next(), Some(&Pair::new(1, None)));
assert_eq!(iterator.next(), None);

pub fn pairs_mut(&mut self) -> impl Iterator<Item = &mut Pair<'a, T>>

Returns an iterator over the Pair sequences as mutable references

let mut punctuated = Punctuated::new();
punctuated.push(Pair::new(1, None));
for item in punctuated.pairs_mut() {
    *item.value_mut() += 1;
}
assert_eq!(punctuated.pop(), Some(Pair::new(2, None)));

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

Pops off the last Pair, if it isn't empty

let mut punctuated = Punctuated::new();
punctuated.push(Pair::new(1, None));
assert_eq!(punctuated.pop(), Some(Pair::new(1, None)));

pub fn push(&mut self, pair: Pair<'a, T>)

Pushes a new Pair onto the sequence

let mut punctuated = Punctuated::new();
punctuated.push(Pair::new(1, None));
assert_eq!(punctuated.pop(), Some(Pair::new(1, None)));

Trait Implementations

impl<'a, T: Clone> Clone for Punctuated<'a, T>

fn clone(&self) -> Punctuated<'a, T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Punctuated<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Default> Default for Punctuated<'a, T>

fn default() -> Punctuated<'a, T>

Returns the "default value" for a type.

impl<'de: 'a, 'a, T> Deserialize<'de> for Punctuated<'a, T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a, T> Display for Punctuated<'a, T> where
    T: Display, 

fn fmt(&self, _derive_more_display_formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a, T> Extend<Pair<'a, T>> for Punctuated<'a, T>

fn extend<I: IntoIterator<Item = Pair<'a, T>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, T> FromIterator<Pair<'a, T>> for Punctuated<'a, T>

fn from_iter<I: IntoIterator<Item = Pair<'a, T>>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a, T> IntoIterator for Punctuated<'a, T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a: 'b, 'b, T> IntoIterator for &'b Punctuated<'a, T>

type Item = &'b T

The type of the elements being iterated over.

type IntoIter = Iter<'a, 'b, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a: 'b, 'b, T> IntoIterator for &'b mut Punctuated<'a, T>

type Item = &'b mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, 'b, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Node<'a>> Node<'a> for Punctuated<'a, T>

fn start_position(&self) -> Option<Position>

The start position of a node. None if can't be determined

fn end_position(&self) -> Option<Position>

The end position of a node. None if it can't be determined

fn similar(&self, other: &Self) -> bool

Whether another node of the same type is the same as this one semantically, ignoring position

fn tokens<'b>(&'b self) -> Tokens<'a, 'b>ⓘ

Important traits for Tokens<'ast, 'b>

impl<'ast, 'b> Iterator for Tokens<'ast, 'b> type Item = Cow<'b, TokenReference<'ast>>;

The token references that comprise a node

fn range(&self) -> Option<(Position, Position)>

The full range of a node, if it has both start and end positions

fn surrounding_trivia<'b>(
    &'b self
) -> (Vec<Cow<'b, Token<'ast>>>, Vec<Cow<'b, Token<'ast>>>)

The tokens surrounding a node that are ignored and not accessible through the node's own accessors. Use this if you want to get surrounding comments or whitespace. Returns a tuple of the leading and trailing trivia.

impl<T, '_> Owned for Punctuated<'_, T> where
    T: Owned, 

type Owned = Punctuated<'static, <T as Owned>::Owned>

What an owned version of the object looks like. Usually contains a 'static lifetime.

fn owned(&self) -> Self::Owned

Returns an owned version of the object.

impl<'a, T: PartialEq> PartialEq<Punctuated<'a, T>> for Punctuated<'a, T>

fn eq(&self, other: &Punctuated<'a, T>) -> bool

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

fn ne(&self, other: &Punctuated<'a, T>) -> bool

This method tests for !=.

impl<'a, T> Serialize for Punctuated<'a, T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a, T> StructuralPartialEq for Punctuated<'a, T>