Struct CommaSeparated

pub struct CommaSeparated<'a, T, const MIN: usize = 1> { /* private fields */ }

This is a generic type that can be used for AST nodes representing multiple multiple items separated with commas.

This can be used for any grammar which defines a Comma Separated group ([]#).

The given <T> will be parsed first, followed by a comma. Parsing completes if the comma isn’t found.

As <T> is parsed first, it can have any number of interior commas, however if T should ideally not consume trailing commas, as doing so would likely mean only a single T in this struct.

The effective grammar for this struct is:

<comma-separated>
 │├─╭─ <T> ─╮─ "," ─╭─┤│
    │       ╰───────╯
    ╰───────╯

Implementations

impl<'a, T, const MIN: usize> CommaSeparated<'a, T, MIN>

pub fn new_in(bump: &'a Bump) -> Self

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Trait Implementations

impl<'a, T: Clone, const MIN: usize> Clone for CommaSeparated<'a, T, MIN>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug, const MIN: usize> Debug for CommaSeparated<'a, T, MIN>

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

Formats the value using the given formatter.

impl<'a, T: Hash, const MIN: usize> Hash for CommaSeparated<'a, T, MIN>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T, I, const MIN: usize> Index<I> for CommaSeparated<'a, T, MIN>

where I: SliceIndex<[(T, Option<Comma>)]>,

type Output = <I as SliceIndex<[(T, Option<Comma>)]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T, I, const MIN: usize> IndexMut<I> for CommaSeparated<'a, T, MIN>

where I: SliceIndex<[(T, Option<Comma>)]>,

fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, 'b, T, const MIN: usize> IntoIterator for &'b CommaSeparated<'a, T, MIN>

type Item = &'b (T, Option<Comma>)

The type of the elements being iterated over.

type IntoIter = Iter<'b, (T, Option<Comma>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, T, const MIN: usize> IntoIterator for &'b mut CommaSeparated<'a, T, MIN>

type Item = &'b mut (T, Option<Comma>)

The type of the elements being iterated over.

type IntoIter = IterMut<'b, (T, Option<Comma>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const MIN: usize> IntoIterator for CommaSeparated<'a, T, MIN>

type Item = (T, Option<Comma>)

The type of the elements being iterated over.

type IntoIter = IntoIter<'a, <CommaSeparated<'a, T, MIN> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Ord, const MIN: usize> Ord for CommaSeparated<'a, T, MIN>

fn cmp(&self, other: &CommaSeparated<'a, T, MIN>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, T: Parse<'a> + Peek<'a>, const MIN: usize> Parse<'a> for CommaSeparated<'a, T, MIN>

fn parse(p: &mut Parser<'a>) -> ParserResult<Self>

fn try_parse(p: &mut Parser<'a>) -> Result<Self>

impl<'a, T: PartialEq, const MIN: usize> PartialEq for CommaSeparated<'a, T, MIN>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: PartialOrd, const MIN: usize> PartialOrd for CommaSeparated<'a, T, MIN>

fn partial_cmp(&self, other: &CommaSeparated<'a, T, MIN>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T: Peek<'a>, const MIN: usize> Peek<'a> for CommaSeparated<'a, T, MIN>

const PEEK_KINDSET: KindSet = T::PEEK_KINDSET

fn peek(p: &Parser<'a>, c: Cursor) -> bool

impl<'a, T, const MIN: usize> Serialize for CommaSeparated<'a, T, MIN>

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: ToCursors, const MIN: usize> ToCursors for CommaSeparated<'a, T, MIN>

fn to_cursors(&self, s: &mut impl CursorSink)

impl<'a, T: ToSpan, const MIN: usize> ToSpan for CommaSeparated<'a, T, MIN>

fn to_span(&self) -> Span

impl<'a, T: Eq, const MIN: usize> Eq for CommaSeparated<'a, T, MIN>

impl<'a, T, const MIN: usize> StructuralPartialEq for CommaSeparated<'a, T, MIN>