reth::builder

Struct WithLaunchContext

Source 
pub struct WithLaunchContext<Builder> { /* private fields */ }
Expand description

A NodeBuilder with it’s launch context already configured.

This exposes the same methods as NodeBuilder but with the launch context already configured, See WithLaunchContext::launch

Implementations§

Source§

impl<Builder> WithLaunchContext<Builder>

Source

pub const fn task_executor(&self) -> &TaskExecutor

Returns a reference to the task executor.

Source§

impl<DB, ChainSpec> WithLaunchContext<NodeBuilder<DB, ChainSpec>>

Source

pub const fn config(&self) -> &NodeConfig<ChainSpec>

Returns a reference to the node builder’s config.

Source§

impl<DB, ChainSpec> WithLaunchContext<NodeBuilder<DB, ChainSpec>>
where DB: Database + DatabaseMetrics + DatabaseMetadata + Clone + Unpin + 'static, ChainSpec: EthChainSpec + EthereumHardforks,

Source

pub fn with_types<T>( self, ) -> WithLaunchContext<NodeBuilderWithTypes<FullNodeTypesAdapter<NodeTypesWithDBAdapter<T, DB>, BlockchainProvider<NodeTypesWithDBAdapter<T, DB>>>>>
where T: NodeTypesWithEngine<ChainSpec = ChainSpec> + NodeTypesForTree,

Configures the types of the node.

Source

pub fn with_types_and_provider<T, P>( self, ) -> WithLaunchContext<NodeBuilderWithTypes<FullNodeTypesAdapter<NodeTypesWithDBAdapter<T, DB>, P>>>
where T: NodeTypesWithEngine<ChainSpec = ChainSpec> + NodeTypesForProvider, P: FullProvider<NodeTypesWithDBAdapter<T, DB>>,

Configures the types of the node and the provider type that will be used by the node.

Source

pub fn node<N>( self, node: N, ) -> WithLaunchContext<NodeBuilderWithComponents<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>, <N as Node<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::ComponentsBuilder, <N as Node<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::AddOns>>
where N: Node<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>, ChainSpec = ChainSpec> + NodeTypesForTree,

Preconfigures the node with a specific node implementation.

This is a convenience method that sets the node’s types and components in one call.

Source

pub async fn launch_node<N>( self, node: N, ) -> Result<NodeHandle<NodeAdapter<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>, <<N as Node<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::ComponentsBuilder as NodeComponentsBuilder<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::Components>, <N as Node<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::AddOns>, Report>
where N: Node<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>, ChainSpec = ChainSpec> + NodeTypesForTree, <N as Node<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::AddOns: RethRpcAddOns<NodeAdapter<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>, <<N as Node<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::ComponentsBuilder as NodeComponentsBuilder<FullNodeTypesAdapter<NodeTypesWithDBAdapter<N, DB>, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::Components>>, <N as NodeTypes>::Primitives: FullNodePrimitives<BlockBody = BlockBody>,

Launches a preconfigured Node

This bootstraps the node internals, creates all the components with the given Node

Returns a NodeHandle that can be used to interact with the node.

Source§

impl<T> WithLaunchContext<NodeBuilderWithTypes<T>>
where T: FullNodeTypes,

Source

pub fn with_components<CB>( self, components_builder: CB, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, ()>>
where CB: NodeComponentsBuilder<T>,

Advances the state of the node builder to the next state where all components are configured

Source§

impl<T, CB> WithLaunchContext<NodeBuilderWithComponents<T, CB, ()>>
where T: FullNodeTypes, CB: NodeComponentsBuilder<T>,

Source

pub fn with_add_ons<AO>( self, add_ons: AO, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where AO: NodeAddOns<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>,

Advances the state of the node builder to the next state where all customizable NodeAddOns types are configured.

Source§

impl<T, CB, AO> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where T: FullNodeTypes, CB: NodeComponentsBuilder<T>, AO: RethRpcAddOns<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>,

Source

pub const fn config( &self, ) -> &NodeConfig<<<T as FullNodeTypes>::Types as NodeTypes>::ChainSpec>

Returns a reference to the node builder’s config.

Source

pub fn apply<F>( self, f: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>,

Apply a function to the builder

Source

pub fn apply_if<F>( self, cond: bool, f: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>,

Apply a function to the builder, if the condition is true.

Source

pub fn on_component_initialized<F>( self, hook: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>) -> Result<(), Report> + Send + 'static,

Sets the hook that is run once the node’s components are initialized.

Source

pub fn on_node_started<F>( self, hook: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(FullNode<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>, AO>) -> Result<(), Report> + Send + 'static,

Sets the hook that is run once the node has started.

Source

pub fn map_add_ons<F>( self, f: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(AO) -> AO,

Modifies the addons with the given closure.

Source

pub fn on_rpc_started<F>( self, hook: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(RpcContext<'_, NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>, <AO as RethRpcAddOns<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>>::EthApi>, RethRpcServerHandles) -> Result<(), Report> + Send + 'static,

Sets the hook that is run once the rpc server is started.

Source

pub fn extend_rpc_modules<F>( self, hook: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(RpcContext<'_, NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>, <AO as RethRpcAddOns<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>>::EthApi>) -> Result<(), Report> + Send + 'static,

Sets the hook that is run to configure the rpc modules.

Source

pub fn install_exex<F, R, E>( self, exex_id: impl Into<String>, exex: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(ExExContext<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>) -> R + Send + 'static, R: Future<Output = Result<E, Report>> + Send, E: Future<Output = Result<(), Report>> + Send,

Installs an ExEx (Execution Extension) in the node.

§Note

The ExEx ID must be unique.

Source

pub fn install_exex_if<F, R, E>( self, cond: bool, exex_id: impl Into<String>, exex: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(ExExContext<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>) -> R + Send + 'static, R: Future<Output = Result<E, Report>> + Send, E: Future<Output = Result<(), Report>> + Send,

Installs an ExEx (Execution Extension) in the node if the condition is true.

§Note

The ExEx ID must be unique.

Source

pub async fn launch_with<L>( self, launcher: L, ) -> Result<<L as LaunchNode<NodeBuilderWithComponents<T, CB, AO>>>::Node, Report>
where L: LaunchNode<NodeBuilderWithComponents<T, CB, AO>>,

Launches the node with the given launcher.

Source

pub fn launch_with_fn<L, R>(self, launcher: L) -> R
where L: FnOnce(WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>) -> R,

Launches the node with the given closure.

Source

pub const fn check_launch( self, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>

Check that the builder can be launched

This is useful when writing tests to ensure that the builder is configured correctly.

Source§

impl<T, DB, CB, AO> WithLaunchContext<NodeBuilderWithComponents<FullNodeTypesAdapter<NodeTypesWithDBAdapter<T, DB>, BlockchainProvider<NodeTypesWithDBAdapter<T, DB>>>, CB, AO>>
where DB: Database + DatabaseMetrics + DatabaseMetadata + Clone + Unpin + 'static, T: NodeTypesWithEngine + NodeTypesForTree, CB: NodeComponentsBuilder<FullNodeTypesAdapter<NodeTypesWithDBAdapter<T, DB>, BlockchainProvider<NodeTypesWithDBAdapter<T, DB>>>>, AO: RethRpcAddOns<NodeAdapter<FullNodeTypesAdapter<NodeTypesWithDBAdapter<T, DB>, BlockchainProvider<NodeTypesWithDBAdapter<T, DB>>>, <CB as NodeComponentsBuilder<FullNodeTypesAdapter<NodeTypesWithDBAdapter<T, DB>, BlockchainProvider<NodeTypesWithDBAdapter<T, DB>>>>>::Components>>,

Source

pub async fn launch( self, ) -> Result<NodeHandle<NodeAdapter<FullNodeTypesAdapter<NodeTypesWithDBAdapter<T, DB>, BlockchainProvider<NodeTypesWithDBAdapter<T, DB>>>, <CB as NodeComponentsBuilder<FullNodeTypesAdapter<NodeTypesWithDBAdapter<T, DB>, BlockchainProvider<NodeTypesWithDBAdapter<T, DB>>>>>::Components>, AO>, Report>

Launches the node with the DefaultNodeLauncher that sets up engine API consensus and rpc

Auto Trait Implementations§

§

impl<Builder> Freeze for WithLaunchContext<Builder>
where Builder: Freeze,

§

impl<Builder> !RefUnwindSafe for WithLaunchContext<Builder>

§

impl<Builder> Send for WithLaunchContext<Builder>
where Builder: Send,

§

impl<Builder> Sync for WithLaunchContext<Builder>
where Builder: Sync,

§

impl<Builder> Unpin for WithLaunchContext<Builder>
where Builder: Unpin,

§

impl<Builder> !UnwindSafe for WithLaunchContext<Builder>

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
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

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

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.