Enum genco::tokens::Item

pub enum Item<L>
where
    L: Lang,
{
    Literal(ItemStr),
    Lang(usize, Box<L::Item>),
    Register(usize, Box<L::Item>),
    Push,
    Line,
    Space,
    Indentation(i16),
    OpenQuote(bool),
    CloseQuote,
    OpenEval,
    CloseEval,
}

A single item in a stream of tokens.

Variants

Literal(ItemStr)

A literal item. Is added as a raw string to the stream of tokens.

Lang(usize, Box<L::Item>)

A language-specific item.

Register(usize, Box<L::Item>)

A language-specific item that is not rendered.

Push

Push a new line unless the current line is empty. Will be flushed on indentation changes.

Line

Push a line. Will be flushed on indentation changes.

Space

Space between language items. Typically a single space.

Multiple spacings in sequence are collapsed into one. A spacing does nothing if at the beginning of a line.

Indentation(i16)

Manage indentation.

An indentation of 0 has no effect.

OpenQuote(bool)

Switch to handling input as a quote.

The argument indicates whether the string contains any interpolated values.

The string content is quoted with the language-specific [quoting method]. [quoting method]: Lang::Openquote_string

CloseQuote

Close the current quote.

OpenEval

Switch on evaluation. Only valid during string handling.

CloseEval

Close evaluation.

Trait Implementations

impl<L> Clone for Item<L>

where L: Lang + Clone, L::Item: Clone,

fn clone(&self) -> Item<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L> Debug for Item<L>

where L: Lang + Debug, L::Item: Debug,

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

Formats the value using the given formatter.

impl<L> FormatInto<L> for Item<L>

where L: Lang,

Formatting an item is the same as simply adding that item to the token stream.

Examples

use genco::prelude::*;
use genco::tokens::{Item, ItemStr};

let foo = Item::Literal(ItemStr::Static("foo"));
let bar = Item::Literal(ItemStr::Box("bar".into()));

let result: Tokens = quote!($foo $bar baz);

assert_eq!("foo bar baz", result.to_string()?);

assert_eq!{
    vec![
        Item::Literal(ItemStr::Static("foo")),
        Item::Space,
        Item::Literal(ItemStr::Box("bar".into())),
        Item::Space,
        Item::Literal(ItemStr::Static("baz")),
    ] as Vec<Item<()>>,
    result,
};

fn format_into(self, tokens: &mut Tokens<L>)

Convert the type into tokens in-place.

impl<'a, L> FromIterator<&'a Item<L>> for Tokens<L>

where L: Lang,

fn from_iter<I: IntoIterator<Item = &'a Item<L>>>(iter: I) -> Self

Creates a value from an iterator.

impl<L> FromIterator<Item<L>> for Tokens<L>

where L: Lang,

fn from_iter<I: IntoIterator<Item = Item<L>>>(iter: I) -> Self

Creates a value from an iterator.

impl<L> Hash for Item<L>

where L: Lang + Hash, L::Item: Hash,

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<L> Ord for Item<L>

where L: Lang + Ord, L::Item: Ord,

fn cmp(&self, other: &Item<L>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<L> PartialEq for Item<L>

where L: Lang + PartialEq, L::Item: PartialEq,

fn eq(&self, other: &Item<L>) -> bool

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

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

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

impl<L> PartialOrd for Item<L>

where L: Lang + PartialOrd, L::Item: PartialOrd,

fn partial_cmp(&self, other: &Item<L>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<L> Eq for Item<L>

where L: Lang + Eq, L::Item: Eq,

impl<L> StructuralPartialEq for Item<L>

where L: Lang,