Skip to main content

Expr

Enum Expr 

Source
pub enum Expr {
Show 56 variants Float(f64), Int(i32), Bool(bool), Null, String(SmolStr), Var(SmolStr, Span), Array(Box<[Self]>, Box<[Span]>), Map(Box<[(Self, Span, Self, Span)]>, Span), Struct(Box<[SmolStr]>, Box<[(SmolStr, Self, Span, Span)]>, Span), StructDeclare(SmolStr, Box<[(SmolStr, TypeExpr, Span)]>, Span), EnumDeclare(SmolStr, Box<[(SmolStr, Box<[TypeExpr]>, Span)]>, Span), NamespacedRef(Box<[SmolStr]>, Span), Match(Box<Self>, Box<[(Self, Box<[Self]>)]>, Option<Box<[Self]>>, Span), GetStructField(Box<Self>, SmolStr, Span, Span), SetStructField(Box<Self>, SmolStr, Box<Self>, Span, Span, Span), VarDeclare(SmolStr, Box<Self>), VarAssign(SmolStr, Box<Self>, Span), Condition(Box<Self>, Box<[Self]>, Span), InlineCondition(Box<Self>, Box<[Self]>, Span), ElseIfBlock(Box<Self>, Box<[Self]>), ElseBlock(Box<[Self]>), AnonymousFunction(Box<[SmolStr]>, Box<[Self]>, Span), WhileBlock(Box<Self>, Box<[Self]>), FunctionCall(Box<[Self]>, Box<[SmolStr]>, Span, Box<[Span]>), ObjFunctionCall(Box<Self>, Box<[Self]>, Box<[SmolStr]>, Span, Span, Box<[Span]>), FunctionDecl(SmolStr, Box<[(SmolStr, Option<TypeExpr>)]>, Rc<[Self]>, Span, Option<(TypeExpr, Span)>), ReturnVal(Box<Option<Self>>), ArrayGetIndex(Box<Self>, Box<Self>, Span), ArrayGetSlice(Box<Self>, Box<Self>, Box<Self>, Span), ArrayModify(Box<Self>, Box<Self>, Box<Self>, Span, Span), ForLoop(SmolStr, Box<Self>, Box<[Self]>, Span), IntForLoop(SmolStr, Box<Self>, Box<Self>, Box<[Self]>, Span, Span), ImportDylib(SmolStr, Box<[(SmolStr, Box<[TypeExpr]>, TypeExpr, Span)]>, Span), HostBlock(SmolStr, Box<[(SmolStr, Box<[TypeExpr]>, TypeExpr, Span)]>, Span), ImportFile(SmolStr, Option<SmolStr>, bool, Span), Break, Continue, EvalBlock(Box<[Self]>), LoopBlock(Box<[Self]>), TryCatchBlock(Box<[Self]>, SmolStr, Box<[Self]>), Mul(Box<Self>, Box<Self>, Span, Span), Div(Box<Self>, Box<Self>, Span, Span), Add(Box<Self>, Box<Self>, Span, Span), Sub(Box<Self>, Box<Self>, Span, Span), Mod(Box<Self>, Box<Self>, Span, Span), Pow(Box<Self>, Box<Self>, Span, Span), Eq(Box<Self>, Box<Self>), NotEq(Box<Self>, Box<Self>), Sup(Box<Self>, Box<Self>, Span, Span), SupEq(Box<Self>, Box<Self>, Span, Span), Inf(Box<Self>, Box<Self>, Span, Span), InfEq(Box<Self>, Box<Self>, Span, Span), BoolAnd(Box<Self>, Box<Self>, Span, Span), BoolOr(Box<Self>, Box<Self>, Span, Span), BoolNeg(Box<Self>, Span, Span), Neg(Box<Self>, Span, Span),
}

Variants§

§

Float(f64)

§

Int(i32)

§

Bool(bool)

§

Null

§

String(SmolStr)

§

Var(SmolStr, Span)

§

Array(Box<[Self]>, Box<[Span]>)

Array(contents, [entire_array, elem_spans…])

§

Map(Box<[(Self, Span, Self, Span)]>, Span)

Map(key-value pairs, span)

§

Struct(Box<[SmolStr]>, Box<[(SmolStr, Self, Span, Span)]>, Span)

Struct(name, fields, span)

§

StructDeclare(SmolStr, Box<[(SmolStr, TypeExpr, Span)]>, Span)

StructDeclare(name, fields, span)

§

EnumDeclare(SmolStr, Box<[(SmolStr, Box<[TypeExpr]>, Span)]>, Span)

EnumDeclare(name, variants: [(variant_name, payload_types, name_span)], span)

§

NamespacedRef(Box<[SmolStr]>, Span)

NamespacedRef(path, span)

A bare namespaced identifier (Color::Red) with no call parentheses or struct braces. The only such form candela has is a nullary enum-variant construction; the compiler resolves it against the enum registry.

§

Match(Box<Self>, Box<[(Self, Box<[Self]>)]>, Option<Box<[Self]>>, Span)

Match(scrutinee, arms: [(pattern_expr, body)], wildcard_body, span)

The arm patterns are parsed as ordinary expressions; the compiler picks the lowering by the scrutinee’s static type. For an enum scrutinee each pattern is a variant pattern (Circle(r) binds the payload); otherwise each pattern is an equality test against the scrutinee.

§

GetStructField(Box<Self>, SmolStr, Span, Span)

GetStructField(struct_expr, field, struct_span, field_span, value_span)

§

SetStructField(Box<Self>, SmolStr, Box<Self>, Span, Span, Span)

SetStructField(struct_expr, field, new_expr, struct_span, field_span, value_span)

§

VarDeclare(SmolStr, Box<Self>)

VarDeclare(name, value),

§

VarAssign(SmolStr, Box<Self>, Span)

VarDeclare(name, value, start, end)

§

Condition(Box<Self>, Box<[Self]>, Span)

Condition(condition, code (contains else_if_blocks and potentially else_block), start, end)

§

InlineCondition(Box<Self>, Box<[Self]>, Span)

InlineCondition - expression-form if/else, always produces a value, must have an else branch

§

ElseIfBlock(Box<Self>, Box<[Self]>)

§

ElseBlock(Box<[Self]>)

§

AnonymousFunction(Box<[SmolStr]>, Box<[Self]>, Span)

AnonymousFunction(args, code, span)

§

WhileBlock(Box<Self>, Box<[Self]>)

§

FunctionCall(Box<[Self]>, Box<[SmolStr]>, Span, Box<[Span]>)

FunctionCall(args, (optional namespace + name), start, end, (arg_start,arg_end))

§

ObjFunctionCall(Box<Self>, Box<[Self]>, Box<[SmolStr]>, Span, Span, Box<[Span]>)

ObjFunctionCall(obj, args, namespace, obj_span, fn_span, arg_markers)

§

FunctionDecl(SmolStr, Box<[(SmolStr, Option<TypeExpr>)]>, Rc<[Self]>, Span, Option<(TypeExpr, Span)>)

FunctionDecl(name, args, code, name_span, return_type)

return_type carries the optional -> Type annotation together with the span of the annotation itself, which is what a mismatch between the declared and the returned type is reported against.

§

ReturnVal(Box<Option<Self>>)

§

ArrayGetIndex(Box<Self>, Box<Self>, Span)

§

ArrayGetSlice(Box<Self>, Box<Self>, Box<Self>, Span)

ArrayGetSlice(array, range_start, range_end, span)

§

ArrayModify(Box<Self>, Box<Self>, Box<Self>, Span, Span)

§

ForLoop(SmolStr, Box<Self>, Box<[Self]>, Span)

ForLoop(loop_var_name, loop_array+code, obj_markers)

§

IntForLoop(SmolStr, Box<Self>, Box<Self>, Box<[Self]>, Span, Span)

IntForLoop(loop_var_name, first_elem, final_elem, code)

§

ImportDylib(SmolStr, Box<[(SmolStr, Box<[TypeExpr]>, TypeExpr, Span)]>, Span)

ImportDylib(lib_path, [(fn_name, fn_args, fn_return_type, fn_name_span)], (start, end))

§

HostBlock(SmolStr, Box<[(SmolStr, Box<[TypeExpr]>, TypeExpr, Span)]>, Span)

HostBlock(namespace, [(fn_name, fn_args, fn_return_type, fn_name_span)], (start, end))

Declares a host namespace whose functions are backed by Rust closures registered on the embedding crate::Engine. Mirrors Self::ImportDylib but dispatches to a registered closure instead of a C symbol.

§

ImportFile(SmolStr, Option<SmolStr>, bool, Span)

ImportFile(path, alias, is_logical, (start, end))

is_logical marks a library import (import "std/string";, an extensionless path): the resolver maps it straight to the shipped library directory and never looks source-relative. A .cdl file import (import "./local.cdl";) has is_logical false and resolves source-relative first. alias is Some for import ... as name;, which binds the module under name::; a bare import (None) merges the module’s symbols into the importing file’s scope.

§

Break

§

Continue

§

EvalBlock(Box<[Self]>)

§

LoopBlock(Box<[Self]>)

§

TryCatchBlock(Box<[Self]>, SmolStr, Box<[Self]>)

TryCatchBlock(try_code, err_var, catch_code)

§

Mul(Box<Self>, Box<Self>, Span, Span)

§

Div(Box<Self>, Box<Self>, Span, Span)

§

Add(Box<Self>, Box<Self>, Span, Span)

§

Sub(Box<Self>, Box<Self>, Span, Span)

§

Mod(Box<Self>, Box<Self>, Span, Span)

§

Pow(Box<Self>, Box<Self>, Span, Span)

§

Eq(Box<Self>, Box<Self>)

§

NotEq(Box<Self>, Box<Self>)

§

Sup(Box<Self>, Box<Self>, Span, Span)

§

SupEq(Box<Self>, Box<Self>, Span, Span)

§

Inf(Box<Self>, Box<Self>, Span, Span)

§

InfEq(Box<Self>, Box<Self>, Span, Span)

§

BoolAnd(Box<Self>, Box<Self>, Span, Span)

§

BoolOr(Box<Self>, Box<Self>, Span, Span)

§

BoolNeg(Box<Self>, Span, Span)

§

Neg(Box<Self>, Span, Span)

Implementations§

Source§

impl Expr

Source

pub fn infer_type( &self, v: &mut Vec<Variable>, ctx: Ctx, state: &mut State<'_>, ) -> DataType

Infers this expression’s static DataType without emitting code.

§Panics

Panics when a call node carries an empty namespace path, which the parser never produces.

Source§

impl Expr

Source

pub const fn is_constant_literal(&self) -> bool

Source

pub fn compile( &self, v: &mut Vec<Variable>, ctx: Ctx, state: &mut State<'_>, output: &mut Vec<Instr>, tgt_id: Option<u16>, var_assignment: bool, uses_id: bool, ) -> Option<u16>

Source

pub fn compile_with_code_context( &self, v: &mut Vec<Variable>, ctx: Ctx, state: &mut State<'_>, output: &mut Vec<Instr>, tgt_id: Option<u16>, var_assignment: bool, remaining_code: &[Self], uses_id: bool, ) -> Option<u16>

Trait Implementations§

Source§

impl Clone for Expr

Source§

fn clone(&self) -> Expr

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Expr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Expr

Source§

fn eq(&self, other: &Expr) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Expr

Auto Trait Implementations§

§

impl Freeze for Expr

§

impl RefUnwindSafe for Expr

§

impl !Send for Expr

§

impl !Sync for Expr

§

impl Unpin for Expr

§

impl UnsafeUnpin for Expr

§

impl UnwindSafe for Expr

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Paint for T
where T: ?Sized,

§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling [Attribute] value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi [Quirk] value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1:

renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the [Condition] value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new [Painted] with a default [Style]. Read more
§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.