Struct Equation

pub struct Equation {
    pub left: Path,
    pub op: Eq,
    pub right: TokenStream,
}

Represents an equation parsed from a procedural macro input.

This struct models an equation consisting of a left-hand side, an operator, and a right-hand side. The Equation is typically constructed during the parsing process of macro input, where the left and op fields are expected to be syntactically represented by syn::Path and syn::BinOp respectively, indicating the variable and operation involved. The right field is a proc_macro2::TokenStream, which can represent more complex expressions including, but not limited to, literals, function calls, or further operations.

Fields

• left: The left-hand side of the equation, represented as a path. This could be a variable or a more complex path in the code being processed by the macro.

• op: The binary operator used in the equation, such as addition, subtraction, multiplication, etc.

• right: The right-hand side of the equation. Given the potential complexity of expressions on this side, it is represented as a proc_macro2::TokenStream to accommodate any valid Rust expression.

Examples

Parsing an equation from macro input:

use macro_tools::equation;
let got : equation::Equation = syn::parse_quote!( default = 31 );
macro_tools::tree_print!( got );
assert_eq!( macro_tools::code_to_str!( got ), "default = 31".to_string() );

Fields

left: Path

The LHS of the equation, represented by a syntactic path.

op: Eq

Equality token.

right: TokenStream

The RHS of the equation, capable of holding complex expressions.

Trait Implementations

impl Debug for Equation

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

Formats the value using the given formatter.

impl Parse for Equation

fn parse(input: &ParseBuffer<'_>) -> Result<Equation, Error>

impl ToTokens for Equation

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.