Skip to main content

StatementKind

Enum StatementKind 

Source
pub enum StatementKind {
Show 41 variants VariableDeclaration { name: String, type_annotation: TypeAnnotation, value: ExprId, }, ResolvedVariableDeclaration { name: String, slot: usize, type_annotation: TypeAnnotation, value: ExprId, }, ConstantDeclaration { name: String, type_annotation: TypeAnnotation, value: ExprId, }, ResolvedConstantDeclaration { name: String, slot: usize, type_annotation: TypeAnnotation, value: ExprId, }, Array { name: String, type_annotation: TypeAnnotation, value: Vec<ExprId>, }, ConstantArray { name: String, type_annotation: TypeAnnotation, value: Vec<ExprId>, }, ResolvedArray { name: String, slot: usize, type_annotation: TypeAnnotation, value: ExprId, }, ResolvedConstantArray { name: String, slot: usize, type_annotation: TypeAnnotation, value: ExprId, }, Map { name: String, type_annotation: TypeAnnotation, entries: Vec<(ExprId, ExprId)>, }, ConstantMap { name: String, type_annotation: TypeAnnotation, entries: Vec<(ExprId, ExprId)>, }, ResolvedMap { name: String, slot: usize, type_annotation: TypeAnnotation, value: ExprId, }, ResolvedConstantMap { name: String, slot: usize, type_annotation: TypeAnnotation, value: ExprId, }, Set { name: String, type_annotation: TypeAnnotation, items: Vec<ExprId>, }, ConstantSet { name: String, type_annotation: TypeAnnotation, items: Vec<ExprId>, }, ResolvedSet { name: String, slot: usize, type_annotation: TypeAnnotation, value: ExprId, }, ResolvedConstantSet { name: String, slot: usize, type_annotation: TypeAnnotation, value: ExprId, }, Expression(ExprId), While { condition: ExprId, body: Vec<Statement>, }, For { initializer: Box<Statement>, condition: ExprId, increment: ExprId, body: Vec<Statement>, }, ResolvedFor { initializer: Box<Statement>, condition: ExprId, increment: ExprId, body: Vec<Statement>, }, ForRange { variable: String, range: Box<Statement>, body: Vec<Statement>, }, ResolvedForRange { slot: usize, variable: String, range: Box<Statement>, body: Vec<Statement>, }, ForEach { variable: String, iterable: ExprId, body: Vec<Statement>, }, ResolvedForEach { slot: usize, variable: String, iterable: ExprId, body: Vec<Statement>, }, Range(Vec<i64>), ConditionalBranch { condition: Option<ExprId>, body: Vec<Statement>, needs_scope: bool, }, Conditional { if_branch: Box<Statement>, else_branch: Option<Box<Statement>>, }, FunctionDeclaration { name: String, params: Vec<Param>, return_type: TypeAnnotation, body: Vec<Statement>, attribute: Option<FunctionAttribute>, }, ResolvedFunctionDeclaration { name: String, slot: usize, params: Vec<Param>, return_type: TypeAnnotation, body: Vec<Statement>, attribute: Option<FunctionAttribute>, }, Return(Option<ExprId>), Break, Continue, Import { names: Vec<String>, path: Vec<String>, }, ImportFile { path: Vec<String>, }, ResolvedImportFile { path: Vec<String>, body: Vec<Statement>, }, ImportFileNamed { path: Vec<String>, names: Vec<String>, }, DestructureDeclaration { bindings: Vec<(TypeAnnotation, String)>, value: ExprId, }, ResolvedDestructureDeclaration { bindings: Vec<(TypeAnnotation, String)>, slots: Vec<usize>, value: ExprId, }, Match { value: ExprId, arms: Vec<(MatchPattern, Vec<Statement>)>, }, RecordDeclaration { name: String, fields: Vec<(String, TypeAnnotation)>, }, TagDeclaration { name: String, variants: Vec<String>, },
}

Variants§

§

VariableDeclaration

A mutable variable declaration: dec T name = value.

Fields

§name: String
§type_annotation: TypeAnnotation
§value: ExprId
§

ResolvedVariableDeclaration

Resolver-annotated mutable variable declaration. slot is the index in the current environment frame.

Fields

§name: String
§slot: usize
§type_annotation: TypeAnnotation
§value: ExprId
§

ConstantDeclaration

An immutable constant declaration: const T NAME = value.

Fields

§name: String
§type_annotation: TypeAnnotation
§value: ExprId
§

ResolvedConstantDeclaration

Resolver-annotated constant declaration.

Fields

§name: String
§slot: usize
§type_annotation: TypeAnnotation
§value: ExprId
§

Array

A mutable array declaration with an inline literal: dec array[T] name = [items].

Fields

§name: String
§type_annotation: TypeAnnotation
§value: Vec<ExprId>
§

ConstantArray

An immutable array declaration with an inline literal: const array[T] NAME = [items].

Fields

§name: String
§type_annotation: TypeAnnotation
§value: Vec<ExprId>
§

ResolvedArray

Resolver-annotated mutable array declaration. value is the initialiser expression (may be an ExpressionKind::ArrayLiteral).

Fields

§name: String
§slot: usize
§type_annotation: TypeAnnotation
§value: ExprId
§

ResolvedConstantArray

Resolver-annotated constant array declaration.

Fields

§name: String
§slot: usize
§type_annotation: TypeAnnotation
§value: ExprId
§

Map

Fields

§name: String
§type_annotation: TypeAnnotation
§entries: Vec<(ExprId, ExprId)>
§

ConstantMap

Fields

§name: String
§type_annotation: TypeAnnotation
§entries: Vec<(ExprId, ExprId)>
§

ResolvedMap

Fields

§name: String
§slot: usize
§type_annotation: TypeAnnotation
§value: ExprId
§

ResolvedConstantMap

Fields

§name: String
§slot: usize
§type_annotation: TypeAnnotation
§value: ExprId
§

Set

Fields

§name: String
§type_annotation: TypeAnnotation
§items: Vec<ExprId>
§

ConstantSet

Fields

§name: String
§type_annotation: TypeAnnotation
§items: Vec<ExprId>
§

ResolvedSet

Fields

§name: String
§slot: usize
§type_annotation: TypeAnnotation
§value: ExprId
§

ResolvedConstantSet

Fields

§name: String
§slot: usize
§type_annotation: TypeAnnotation
§value: ExprId
§

Expression(ExprId)

A bare expression used as a statement (e.g. a function call whose return value is discarded, or a newline placeholder).

§

While

A while condition { body } loop.

Fields

§condition: ExprId
§

For

A C-style for [init, cond, incr] { body } loop.

Fields

§initializer: Box<Statement>
§condition: ExprId
§increment: ExprId
§

ResolvedFor

Resolver-annotated C-style for loop.

Fields

§initializer: Box<Statement>
§condition: ExprId
§increment: ExprId
§

ForRange

A range-based for x in N..M { body } loop. The range is pre-evaluated at parse time into a [Range] statement.

Fields

§variable: String
§

ResolvedForRange

Resolver-annotated range-based for loop. slot is the loop variable’s environment index.

Fields

§slot: usize
§variable: String
§

ForEach

A foreach for item in iterable { body } loop over an array expression.

Fields

§variable: String
§iterable: ExprId
§

ResolvedForEach

Resolver-annotated foreach loop.

Fields

§slot: usize
§variable: String
§iterable: ExprId
§

Range(Vec<i64>)

A pre-evaluated integer range produced by the parser for for x in N..M.

§

ConditionalBranch

A single branch of a conditional: either if condition { body } (condition is Some) or else { body } (condition is None).

Fields

§condition: Option<ExprId>
§needs_scope: bool

Precomputed by the resolver true if body declares any local variable/constant and therefore needs its own scope frame

§

Conditional

A full if / else-if / else chain.

Fields

§if_branch: Box<Statement>
§else_branch: Option<Box<Statement>>
§

FunctionDeclaration

A named function declaration.

Fields

§name: String
§params: Vec<Param>
§return_type: TypeAnnotation
§attribute: Option<FunctionAttribute>

true when the function is marked with !#[entry].

§

ResolvedFunctionDeclaration

Resolver-annotated function declaration. slot is the function’s index in the current environment frame.

Fields

§name: String
§slot: usize
§params: Vec<Param>
§return_type: TypeAnnotation
§

Return(Option<ExprId>)

A return expr or bare return statement.

§

Break

Breaks out of the nearest enclosing loop.

§

Continue

Skips to the next iteration of the nearest enclosing loop.

§

Import

A stdlib import: get std::ns::fn or get fn from std::ns.

Fields

§names: Vec<String>

names of the imported functions

§path: Vec<String>

module path (e.g. ["std", "math"])

§

ImportFile

A file module import: get mymodule or get mymodule::sub.

Fields

§path: Vec<String>
§

ResolvedImportFile

A resolved file import - the imported file’s statements are inlined here.

Fields

§path: Vec<String>
§

ImportFileNamed

A named file import: get fn, fn from mymodule::sub.

Fields

§path: Vec<String>
§names: Vec<String>
§

DestructureDeclaration

Fields

§value: ExprId
§

ResolvedDestructureDeclaration

Fields

§slots: Vec<usize>
§value: ExprId
§

Match

Fields

§value: ExprId
§

RecordDeclaration

A record (struct) type declaration: record Name { int a, string b }.

Fields

§name: String
§

TagDeclaration

A tag (enum) type declaration: tag Name { VariantA, VariantB }.

Fields

§name: String
§variants: Vec<String>

Trait Implementations§

Source§

impl Clone for StatementKind

Source§

fn clone(&self) -> StatementKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StatementKind

Source§

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

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

impl PartialEq for StatementKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 StatementKind

Auto Trait Implementations§

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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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.