Struct embed_nu::ContextBuilder

impl ContextBuilder

pub fn with_command_groups( self, group_config: CommandGroupConfig ) -> Result<Self, CrateError>

Enables certain command groups specified in the Config on the state

pub fn add_command<C: Command + 'static>( self, command: C ) -> Result<Self, CrateError>

Adds a custom command to the engine that can be used inside nu expressions This method can also be used to pass nu builtin commands to enable single commands Instead of whole command groups

pub fn add_var<S: ToString, V: IntoValue>( self, name: S, value: V ) -> Result<Self, CrateError>

Adds a variable to the state

pub fn add_env_var<S: ToString, V: IntoValue>(self, name: S, value: V) -> Self

Adds an environment variable to the state

pub fn add_parent_env_vars(self) -> Self

Adds the environment variables of the parent process to the states env variables

pub fn add_block(self, block: Block) -> Self

Adds a block to the builder This block is evaluated when building to put the blocks contents in scope. Note: Code not contained in declarations is being executed when building the context

pub fn add_script(self, contents: String) -> Result<Self, CrateError>

Adds a script to the context. This script is being parsed so this operation can fail

pub fn build(self) -> Result<Context, CrateError>

builds the context

Trait Implementations§

impl Default for ContextBuilder

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for ContextBuilder

impl !UnwindSafe for ContextBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more