Struct genco::Tokens

pub struct Tokens<'el, C: 'el> { /* fields omitted */ }

A set of tokens.

Implementations

impl<'el, C: 'el> Tokens<'el, C> where
    C: PartialEq + Eq, 

Generic methods.

pub fn new() -> Tokens<'el, C>

Create a new set of tokens.

pub fn nested<T>(&mut self, tokens: T) where
    T: IntoTokens<'el, C>, 

Push a nested definition.

pub fn nested_into<B>(&mut self, builder: B) where
    B: FnOnce(&mut Tokens<'el, C>), 

Push a nested definition.

pub fn try_nested_into<E, B>(&mut self, builder: B) -> Result<(), E> where
    B: FnOnce(&mut Tokens<'el, C>) -> Result<(), E>, 

Push a nested definition.

This is a fallible version that expected the builder to return a result.

pub fn nested_ref(&mut self, tokens: &'el Tokens<'el, C>)

Push a nested reference to a definition.

pub fn push<T>(&mut self, tokens: T) where
    T: IntoTokens<'el, C>, 

Push a definition, guaranteed to be preceded with one newline.

pub fn push_into<B>(&mut self, builder: B) where
    B: FnOnce(&mut Tokens<'el, C>), 

Push a new created definition, guaranteed to be preceded with one newline.

pub fn try_push_into<E, B>(&mut self, builder: B) -> Result<(), E> where
    B: FnOnce(&mut Tokens<'el, C>) -> Result<(), E>, 

Push a new created definition, guaranteed to be preceded with one newline.

This is a fallible version that expected the builder to return a result.

pub fn push_unless_empty<T>(&mut self, tokens: T) where
    T: IntoTokens<'el, C>, 

Push the given set of tokens, unless it is empty.

This is useful when you wish to preserve the structure of nested and joined tokens.

pub fn push_ref(&mut self, tokens: &'el Tokens<'el, C>)

Push a reference to a definition.

pub fn insert<E>(&mut self, pos: usize, element: E) where
    E: Into<Element<'el, C>>, 

Insert the given element.

pub fn append<E>(&mut self, element: E) where
    E: Into<Element<'el, C>>, 

Append the given element.

pub fn append_ref(&mut self, element: &'el Element<'el, C>)

Append a reference to a definition.

pub fn append_unless_empty<T>(&mut self, tokens: T) where
    T: IntoTokens<'el, C>, 

Append the given set of tokens, unless it is empty.

This is useful when you wish to preserve the structure of nested and joined tokens.

pub fn extend<I>(&mut self, it: I) where
    I: IntoIterator<Item = Element<'el, C>>, 

Extend with another set of tokens.

pub fn walk_custom(&self) -> WalkCustom<C>

Walk over all elements.

pub fn register(&mut self, custom: C)

Add an registered custom element that is not rendered.

pub fn is_empty(&self) -> bool

Check if tokens contain no elements.

impl<'el, C: Custom> Tokens<'el, C>

pub fn format(
    &self,
    out: &mut Formatter,
    config: &mut C::Config,
    level: usize
) -> Result

Format the tokens.

pub fn to_file_with(self, config: C::Config) -> Result<String, Error>

Format token as file with the given configuration.

pub fn to_string_with(self, config: C::Config) -> Result<String, Error>

Format the tokens with the given configuration.

impl<'el, E: Config + Default, C: Custom<Config = E>> Tokens<'el, C>

pub fn to_file(self) -> Result<String, Error>

Format token as file.

pub fn to_string(self) -> Result<String, Error>

Format the tokens.

impl<'el, C> Tokens<'el, C> where
    C: Clone + PartialEq + Eq, 

Methods only available for clonable elements.

pub fn join<E>(self, element: E) -> Tokens<'el, C> where
    E: Into<Element<'el, C>>, 

Join the set of tokens on the given element.

pub fn join_spacing(self) -> Tokens<'el, C>

Join with spacing.

pub fn join_line_spacing(self) -> Tokens<'el, C>

Join with line spacing.

Trait Implementations

impl<'el, C: Clone + 'el> Clone for Tokens<'el, C>

fn clone(&self) -> Tokens<'el, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'el, C: Debug + 'el> Debug for Tokens<'el, C>

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

Formats the value using the given formatter.

impl<'el, C: Default + 'el> Default for Tokens<'el, C>

fn default() -> Tokens<'el, C>

Returns the "default value" for a type.

impl<'el, C: Eq + 'el> Eq for Tokens<'el, C>

impl<'el> From<&'el Csharp<'el>> for Tokens<'el, Csharp<'el>>

fn from(value: &'el Csharp<'el>) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<&'el Dart<'el>> for Tokens<'el, Dart<'el>>

fn from(value: &'el Dart<'el>) -> Tokens<'el, Dart<'el>>

Performs the conversion.

impl<'el> From<&'el Java<'el>> for Tokens<'el, Java<'el>>

fn from(value: &'el Java<'el>) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<&'el JavaScript<'el>> for Tokens<'el, JavaScript<'el>>

fn from(value: &'el JavaScript<'el>) -> Tokens<'el, JavaScript<'el>>

Performs the conversion.

impl<'el> From<&'el Python<'el>> for Tokens<'el, Python<'el>>

fn from(value: &'el Python<'el>) -> Tokens<'el, Python<'el>>

Performs the conversion.

impl<'el> From<&'el Rust<'el>> for Tokens<'el, Rust<'el>>

fn from(value: &'el Rust<'el>) -> Tokens<'el, Rust<'el>>

Performs the conversion.

impl<'el, C> From<&'el Tokens<'el, C>> for Element<'el, C>

fn from(value: &'el Tokens<'el, C>) -> Self

Performs the conversion.

impl<'el, C> From<&'el str> for Tokens<'el, C>

fn from(value: &'el str) -> Tokens<'el, C>

Performs the conversion.

impl<'el> From<(Cons<'el>, Constructor<'el>)> for Tokens<'el, Csharp<'el>>

fn from(value: (Cons<'el>, Constructor<'el>)) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<(Cons<'el>, Constructor<'el>)> for Tokens<'el, Java<'el>>

fn from(value: (Cons<'el>, Constructor<'el>)) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<Argument<'el>> for Tokens<'el, Csharp<'el>>

fn from(value: Argument<'el>) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<Argument<'el>> for Tokens<'el, Java<'el>>

fn from(value: Argument<'el>) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<Class<'el>> for Tokens<'el, Csharp<'el>>

fn from(value: Class<'el>) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<Class<'el>> for Tokens<'el, Java<'el>>

fn from(value: Class<'el>) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<Csharp<'el>> for Tokens<'el, Csharp<'el>>

fn from(value: Csharp<'el>) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<Dart<'el>> for Tokens<'el, Dart<'el>>

fn from(value: Dart<'el>) -> Tokens<'el, Dart<'el>>

Performs the conversion.

impl<'el, C> From<Element<'el, C>> for Tokens<'el, C>

fn from(value: Element<'el, C>) -> Tokens<'el, C>

Performs the conversion.

impl<'el> From<Enum<'el>> for Tokens<'el, Csharp<'el>>

fn from(value: Enum<'el>) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<Enum<'el>> for Tokens<'el, Java<'el>>

fn from(value: Enum<'el>) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<Field<'el>> for Tokens<'el, Csharp<'el>>

fn from(value: Field<'el>) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<Field<'el>> for Tokens<'el, Java<'el>>

fn from(value: Field<'el>) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<Interface<'el>> for Tokens<'el, Csharp<'el>>

fn from(value: Interface<'el>) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<Interface<'el>> for Tokens<'el, Java<'el>>

fn from(value: Interface<'el>) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<Java<'el>> for Tokens<'el, Java<'el>>

fn from(value: Java<'el>) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<JavaScript<'el>> for Tokens<'el, JavaScript<'el>>

fn from(value: JavaScript<'el>) -> Tokens<'el, JavaScript<'el>>

Performs the conversion.

impl<'el> From<Method<'el>> for Tokens<'el, Csharp<'el>>

fn from(value: Method<'el>) -> Tokens<'el, Csharp<'el>>

Performs the conversion.

impl<'el> From<Method<'el>> for Tokens<'el, Java<'el>>

fn from(value: Method<'el>) -> Tokens<'el, Java<'el>>

Performs the conversion.

impl<'el> From<Python<'el>> for Tokens<'el, Python<'el>>

fn from(value: Python<'el>) -> Tokens<'el, Python<'el>>

Performs the conversion.

impl<'el> From<Rust<'el>> for Tokens<'el, Rust<'el>>

fn from(value: Rust<'el>) -> Tokens<'el, Rust<'el>>

Performs the conversion.

impl<'el, C> From<String> for Tokens<'el, C>

fn from(value: String) -> Tokens<'el, C>

Performs the conversion.

impl<'el, C> From<Tokens<'el, C>> for Element<'el, C>

fn from(value: Tokens<'el, C>) -> Self

Performs the conversion.

impl<'el, C> From<Vec<Tokens<'el, C>>> for Tokens<'el, C>

fn from(value: Vec<Tokens<'el, C>>) -> Tokens<'el, C>

Performs the conversion.

impl<'el, C> FromIterator<&'el Element<'el, C>> for Tokens<'el, C>

fn from_iter<I: IntoIterator<Item = &'el Element<'el, C>>>(
    iter: I
) -> Tokens<'el, C>

Creates a value from an iterator.

impl<'el, C> FromIterator<Element<'el, C>> for Tokens<'el, C>

fn from_iter<I: IntoIterator<Item = Element<'el, C>>>(iter: I) -> Tokens<'el, C>

Creates a value from an iterator.

impl<'el, C> IntoIterator for Tokens<'el, C>

type Item = Element<'el, C>

The type of the elements being iterated over.

type IntoIter = IntoIter<Element<'el, C>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'el, C> IntoTokens<'el, C> for Tokens<'el, C>

fn into_tokens(self) -> Tokens<'el, C>

Convert the type into tokens.

impl<'el, C: PartialEq + 'el> PartialEq<Tokens<'el, C>> for Tokens<'el, C>

fn eq(&self, other: &Tokens<'el, C>) -> bool

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

fn ne(&self, other: &Tokens<'el, C>) -> bool

This method tests for !=.

impl<'el, C: 'el> StructuralEq for Tokens<'el, C>

impl<'el, C: 'el> StructuralPartialEq for Tokens<'el, C>