Skip to main content

AST

Enum AST 

Source
pub enum AST {
Show 51 variants Statement(Box<AST>, Option<LineInfo>), Omen(bool, Option<LineInfo>), Arcana(i64, Option<LineInfo>), Aether(f64, Option<LineInfo>), Rune(String, Option<LineInfo>), Abyss(Option<LineInfo>), Add(Box<AST>, Box<AST>, Option<LineInfo>), Sub(Box<AST>, Box<AST>, Option<LineInfo>), Mul(Box<AST>, Box<AST>, Option<LineInfo>), Div(Box<AST>, Box<AST>, Option<LineInfo>), Mod(Box<AST>, Box<AST>, Option<LineInfo>), PowArcana(Box<AST>, Box<AST>, Option<LineInfo>), PowAether(Box<AST>, Box<AST>, Option<LineInfo>), Equal(Box<AST>, Box<AST>, Option<LineInfo>), NotEqual(Box<AST>, Box<AST>, Option<LineInfo>), LessThan(Box<AST>, Box<AST>, Option<LineInfo>), LessThanOrEqual(Box<AST>, Box<AST>, Option<LineInfo>), GreaterThan(Box<AST>, Box<AST>, Option<LineInfo>), GreaterThanOrEqual(Box<AST>, Box<AST>, Option<LineInfo>), LogicalAnd(Box<AST>, Box<AST>, Option<LineInfo>), LogicalOr(Box<AST>, Box<AST>, Option<LineInfo>), LogicalNot(Box<AST>, Option<LineInfo>), VarAssign { name: String, value: Box<AST>, var_type: Type, is_morph: bool, line_info: Option<LineInfo>, }, Assignment { name: String, value: Box<AST>, op: AssignmentOp, line_info: Option<LineInfo>, }, Var(String, Option<LineInfo>), Reveal(Box<AST>, Option<LineInfo>), Oracle { is_match: bool, conditionals: Vec<ConditionalAssignment>, branches: Vec<AST>, line_info: Option<LineInfo>, }, OracleBranch { pattern: Vec<AST>, guard: Option<Box<AST>>, body: Box<AST>, line_info: Option<LineInfo>, }, OracleDontCareItem(Option<LineInfo>), OracleScrollPattern { elements: Vec<AST>, line_info: Option<LineInfo>, }, OracleScrollRest { name: Option<String>, line_info: Option<LineInfo>, }, OracleArtifactPattern { type_name: String, fields: Vec<(String, AST)>, line_info: Option<LineInfo>, }, OracleLexiconPattern { entries: Vec<(String, AST)>, line_info: Option<LineInfo>, }, Block(Vec<AST>, Option<LineInfo>), Comment(String, Option<LineInfo>), Orbit { params: Vec<AST>, body: Box<AST>, line_info: Option<LineInfo>, }, OrbitParam { name: String, start: Box<AST>, end: Box<AST>, op: String, line_info: Option<LineInfo>, }, Resume(Option<String>, Option<LineInfo>), Eject(Option<String>, Option<LineInfo>), Engrave { name: String, params: Vec<AST>, return_type: Type, body: Box<AST>, method_target: Option<ArtifactMethodTarget>, line_info: Option<LineInfo>, }, EngraveParam { name: String, param_type: Type, is_morph: bool, line_info: Option<LineInfo>, }, FuncCall { name: String, args: Vec<AST>, line_info: Option<LineInfo>, }, ListLiteral { elements: Vec<AST>, line_info: Option<LineInfo>, }, MapLiteral { entries: Vec<(String, AST)>, line_info: Option<LineInfo>, }, IndexAccess { target: Box<AST>, index: Box<AST>, line_info: Option<LineInfo>, }, IndexAssignment { target: Box<AST>, index: Box<AST>, value: Box<AST>, line_info: Option<LineInfo>, }, ArtifactDef { name: String, fields: Vec<ArtifactField>, line_info: Option<LineInfo>, }, ArtifactLiteral { type_name: String, fields: Vec<(String, AST)>, line_info: Option<LineInfo>, }, FieldAccess { target: Box<AST>, field: String, line_info: Option<LineInfo>, }, FieldAssignment { target: Box<AST>, field: String, value: Box<AST>, line_info: Option<LineInfo>, }, MethodCall { receiver: Box<AST>, method: String, args: Vec<AST>, line_info: Option<LineInfo>, },
}
Expand description

Represents the abstract syntax tree (AST) for the language.

Variants§

§

Statement(Box<AST>, Option<LineInfo>)

§

Omen(bool, Option<LineInfo>)

§

Arcana(i64, Option<LineInfo>)

§

Aether(f64, Option<LineInfo>)

§

Rune(String, Option<LineInfo>)

§

Abyss(Option<LineInfo>)

§

Add(Box<AST>, Box<AST>, Option<LineInfo>)

§

Sub(Box<AST>, Box<AST>, Option<LineInfo>)

§

Mul(Box<AST>, Box<AST>, Option<LineInfo>)

§

Div(Box<AST>, Box<AST>, Option<LineInfo>)

§

Mod(Box<AST>, Box<AST>, Option<LineInfo>)

§

PowArcana(Box<AST>, Box<AST>, Option<LineInfo>)

§

PowAether(Box<AST>, Box<AST>, Option<LineInfo>)

§

Equal(Box<AST>, Box<AST>, Option<LineInfo>)

§

NotEqual(Box<AST>, Box<AST>, Option<LineInfo>)

§

LessThan(Box<AST>, Box<AST>, Option<LineInfo>)

§

LessThanOrEqual(Box<AST>, Box<AST>, Option<LineInfo>)

§

GreaterThan(Box<AST>, Box<AST>, Option<LineInfo>)

§

GreaterThanOrEqual(Box<AST>, Box<AST>, Option<LineInfo>)

§

LogicalAnd(Box<AST>, Box<AST>, Option<LineInfo>)

§

LogicalOr(Box<AST>, Box<AST>, Option<LineInfo>)

§

LogicalNot(Box<AST>, Option<LineInfo>)

§

VarAssign

Fields

§name: String
§value: Box<AST>
§var_type: Type
§is_morph: bool
§line_info: Option<LineInfo>
§

Assignment

Fields

§name: String
§value: Box<AST>
§line_info: Option<LineInfo>
§

Var(String, Option<LineInfo>)

§

Reveal(Box<AST>, Option<LineInfo>)

§

Oracle

Fields

§is_match: bool
§branches: Vec<AST>
§line_info: Option<LineInfo>
§

OracleBranch

Fields

§pattern: Vec<AST>
§guard: Option<Box<AST>>
§body: Box<AST>
§line_info: Option<LineInfo>
§

OracleDontCareItem(Option<LineInfo>)

§

OracleScrollPattern

Scroll-shape pattern that destructures a scroll scrutinee into its elements. Each element is one of: OracleDontCareItem, OracleScrollRest, Var(name) (binding), or any other AST node (treated as a literal expression to compare against).

Fields

§elements: Vec<AST>
§line_info: Option<LineInfo>
§

OracleScrollRest

Rest segment inside an OracleScrollPattern. name = Some("rest") for ..rest (binds the unmatched tail to a fresh sub-scroll); name = None for .. (anonymous, drops the tail).

Fields

§line_info: Option<LineInfo>
§

OracleArtifactPattern

Artifact-shape pattern that matches a TypeName { field, … } scrutinee. Each (field_name, sub_pattern) entry pulls the named field out of the artifact and matches it against sub_pattern (typically Var for binding, a literal for compare, or OracleDontCareItem to ignore). Fields not listed here are not matched against — the pattern is non-exhaustive by default, so users can pick out only the fields they care about.

Fields

§type_name: String
§fields: Vec<(String, AST)>
§line_info: Option<LineInfo>
§

OracleLexiconPattern

Lexicon-shape pattern that matches a { "key": value, … } scrutinee. Each (key, sub_pattern) entry pulls the named entry out of the lexicon and matches it against sub_pattern. Keys not listed here are not matched against — the pattern is non-exhaustive by default, mirroring the artifact pattern’s “pick what you need” ergonomics.

Fields

§entries: Vec<(String, AST)>
§line_info: Option<LineInfo>
§

Block(Vec<AST>, Option<LineInfo>)

§

Comment(String, Option<LineInfo>)

§

Orbit

Fields

§params: Vec<AST>
§body: Box<AST>
§line_info: Option<LineInfo>
§

OrbitParam

Fields

§name: String
§start: Box<AST>
§end: Box<AST>
§line_info: Option<LineInfo>
§

Resume(Option<String>, Option<LineInfo>)

§

Eject(Option<String>, Option<LineInfo>)

§

Engrave

Fields

§name: String
§params: Vec<AST>
§return_type: Type
§body: Box<AST>
§line_info: Option<LineInfo>
§

EngraveParam

Fields

§name: String
§param_type: Type
§is_morph: bool
§line_info: Option<LineInfo>
§

FuncCall

Fields

§name: String
§args: Vec<AST>
§line_info: Option<LineInfo>
§

ListLiteral

Fields

§elements: Vec<AST>
§line_info: Option<LineInfo>
§

MapLiteral

Fields

§entries: Vec<(String, AST)>
§line_info: Option<LineInfo>
§

IndexAccess

Fields

§target: Box<AST>
§index: Box<AST>
§line_info: Option<LineInfo>
§

IndexAssignment

Fields

§target: Box<AST>
§index: Box<AST>
§value: Box<AST>
§line_info: Option<LineInfo>
§

ArtifactDef

Fields

§name: String
§line_info: Option<LineInfo>
§

ArtifactLiteral

Fields

§type_name: String
§fields: Vec<(String, AST)>
§line_info: Option<LineInfo>
§

FieldAccess

Fields

§target: Box<AST>
§field: String
§line_info: Option<LineInfo>
§

FieldAssignment

Fields

§target: Box<AST>
§field: String
§value: Box<AST>
§line_info: Option<LineInfo>
§

MethodCall

Fields

§receiver: Box<AST>
§method: String
§args: Vec<AST>
§line_info: Option<LineInfo>

Trait Implementations§

Source§

impl Clone for AST

Source§

fn clone(&self) -> AST

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 AST

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for AST

§

impl RefUnwindSafe for AST

§

impl Send for AST

§

impl Sync for AST

§

impl Unpin for AST

§

impl UnsafeUnpin for AST

§

impl UnwindSafe for AST

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.

Source§

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

Source§

type Proj<U: 'src> = U

Source§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

Source§

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

Source§

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();
Source§

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

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

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

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

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

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

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));
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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();
Source§

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

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

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

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

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

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

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));
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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();
Source§

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

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

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

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

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

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

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

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

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

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());
Source§

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

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

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

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

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

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

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

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

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

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();
Source§

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

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

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

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

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

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

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

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

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

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());
Source§

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

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

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

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

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

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

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

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

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

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);
Source§

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

Create a new Painted with a default Style. Read more
Source§

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<'p, T> Seq<'p, T> for T
where T: Clone,

Source§

type Item<'a> = &'a T where T: 'a

The item yielded by the iterator.
Source§

type Iter<'a> = Once<&'a T> where T: 'a

An iterator over the items within this container, by reference.
Source§

fn seq_iter(&self) -> <T as Seq<'p, T>>::Iter<'_>

Iterate over the elements of the container.
Source§

fn contains(&self, val: &T) -> bool
where T: PartialEq,

Check whether an item is contained within this sequence.
Source§

fn to_maybe_ref<'b>(item: <T as Seq<'p, T>>::Item<'b>) -> Maybe<T, &'p T>
where 'p: 'b,

Convert an item of the sequence into a MaybeRef.
Source§

impl<T, S> SpanWrap<S> for T
where S: WrappingSpan<T>,

Source§

fn with_span(self, span: S) -> <S as WrappingSpan<Self>>::Spanned

Invokes WrappingSpan::make_wrapped to wrap an AST node in a span.
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.
Source§

impl<T> OrderedSeq<'_, T> for T
where T: Clone,