pub struct ConfigBuilder<S: State = Empty> { /* private fields */ }Expand description
Use builder syntax to set the inputs and finish with build().
Implementations§
Source§impl<S: State> ConfigBuilder<S>
impl<S: State> ConfigBuilder<S>
Sourcepub fn build(self) -> Configwhere
S: IsComplete,
pub fn build(self) -> Configwhere
S: IsComplete,
Finish building and return the requested object
Sourcepub fn lintspec(self, value: BaseConfig) -> ConfigBuilder<SetLintspec<S>>where
S::Lintspec: IsUnset,
pub fn lintspec(self, value: BaseConfig) -> ConfigBuilder<SetLintspec<S>>where
S::Lintspec: IsUnset,
Sourcepub fn maybe_lintspec(
self,
value: Option<BaseConfig>,
) -> ConfigBuilder<SetLintspec<S>>where
S::Lintspec: IsUnset,
pub fn maybe_lintspec(
self,
value: Option<BaseConfig>,
) -> ConfigBuilder<SetLintspec<S>>where
S::Lintspec: IsUnset,
Sourcepub fn output(self, value: OutputConfig) -> ConfigBuilder<SetOutput<S>>where
S::Output: IsUnset,
pub fn output(self, value: OutputConfig) -> ConfigBuilder<SetOutput<S>>where
S::Output: IsUnset,
Sourcepub fn maybe_output(
self,
value: Option<OutputConfig>,
) -> ConfigBuilder<SetOutput<S>>where
S::Output: IsUnset,
pub fn maybe_output(
self,
value: Option<OutputConfig>,
) -> ConfigBuilder<SetOutput<S>>where
S::Output: IsUnset,
Sourcepub fn constructors(
self,
value: WithParamsRules,
) -> ConfigBuilder<SetConstructors<S>>where
S::Constructors: IsUnset,
pub fn constructors(
self,
value: WithParamsRules,
) -> ConfigBuilder<SetConstructors<S>>where
S::Constructors: IsUnset,
Sourcepub fn maybe_constructors(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetConstructors<S>>where
S::Constructors: IsUnset,
pub fn maybe_constructors(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetConstructors<S>>where
S::Constructors: IsUnset,
Sourcepub fn contracts(self, value: ContractRules) -> ConfigBuilder<SetContracts<S>>where
S::Contracts: IsUnset,
pub fn contracts(self, value: ContractRules) -> ConfigBuilder<SetContracts<S>>where
S::Contracts: IsUnset,
Sourcepub fn maybe_contracts(
self,
value: Option<ContractRules>,
) -> ConfigBuilder<SetContracts<S>>where
S::Contracts: IsUnset,
pub fn maybe_contracts(
self,
value: Option<ContractRules>,
) -> ConfigBuilder<SetContracts<S>>where
S::Contracts: IsUnset,
Sourcepub fn interfaces(self, value: ContractRules) -> ConfigBuilder<SetInterfaces<S>>where
S::Interfaces: IsUnset,
pub fn interfaces(self, value: ContractRules) -> ConfigBuilder<SetInterfaces<S>>where
S::Interfaces: IsUnset,
Sourcepub fn maybe_interfaces(
self,
value: Option<ContractRules>,
) -> ConfigBuilder<SetInterfaces<S>>where
S::Interfaces: IsUnset,
pub fn maybe_interfaces(
self,
value: Option<ContractRules>,
) -> ConfigBuilder<SetInterfaces<S>>where
S::Interfaces: IsUnset,
Sourcepub fn libraries(self, value: ContractRules) -> ConfigBuilder<SetLibraries<S>>where
S::Libraries: IsUnset,
pub fn libraries(self, value: ContractRules) -> ConfigBuilder<SetLibraries<S>>where
S::Libraries: IsUnset,
Sourcepub fn maybe_libraries(
self,
value: Option<ContractRules>,
) -> ConfigBuilder<SetLibraries<S>>where
S::Libraries: IsUnset,
pub fn maybe_libraries(
self,
value: Option<ContractRules>,
) -> ConfigBuilder<SetLibraries<S>>where
S::Libraries: IsUnset,
Sourcepub fn enums(self, value: WithParamsRules) -> ConfigBuilder<SetEnums<S>>where
S::Enums: IsUnset,
pub fn enums(self, value: WithParamsRules) -> ConfigBuilder<SetEnums<S>>where
S::Enums: IsUnset,
Sourcepub fn maybe_enums(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetEnums<S>>where
S::Enums: IsUnset,
pub fn maybe_enums(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetEnums<S>>where
S::Enums: IsUnset,
Sourcepub fn errors(self, value: WithParamsRules) -> ConfigBuilder<SetErrors<S>>where
S::Errors: IsUnset,
pub fn errors(self, value: WithParamsRules) -> ConfigBuilder<SetErrors<S>>where
S::Errors: IsUnset,
Sourcepub fn maybe_errors(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetErrors<S>>where
S::Errors: IsUnset,
pub fn maybe_errors(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetErrors<S>>where
S::Errors: IsUnset,
Sourcepub fn events(self, value: WithParamsRules) -> ConfigBuilder<SetEvents<S>>where
S::Events: IsUnset,
pub fn events(self, value: WithParamsRules) -> ConfigBuilder<SetEvents<S>>where
S::Events: IsUnset,
Sourcepub fn maybe_events(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetEvents<S>>where
S::Events: IsUnset,
pub fn maybe_events(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetEvents<S>>where
S::Events: IsUnset,
Sourcepub fn functions(self, value: FunctionConfig) -> ConfigBuilder<SetFunctions<S>>where
S::Functions: IsUnset,
pub fn functions(self, value: FunctionConfig) -> ConfigBuilder<SetFunctions<S>>where
S::Functions: IsUnset,
Sourcepub fn maybe_functions(
self,
value: Option<FunctionConfig>,
) -> ConfigBuilder<SetFunctions<S>>where
S::Functions: IsUnset,
pub fn maybe_functions(
self,
value: Option<FunctionConfig>,
) -> ConfigBuilder<SetFunctions<S>>where
S::Functions: IsUnset,
Sourcepub fn modifiers(self, value: WithParamsRules) -> ConfigBuilder<SetModifiers<S>>where
S::Modifiers: IsUnset,
pub fn modifiers(self, value: WithParamsRules) -> ConfigBuilder<SetModifiers<S>>where
S::Modifiers: IsUnset,
Sourcepub fn maybe_modifiers(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetModifiers<S>>where
S::Modifiers: IsUnset,
pub fn maybe_modifiers(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetModifiers<S>>where
S::Modifiers: IsUnset,
Sourcepub fn structs(self, value: WithParamsRules) -> ConfigBuilder<SetStructs<S>>where
S::Structs: IsUnset,
pub fn structs(self, value: WithParamsRules) -> ConfigBuilder<SetStructs<S>>where
S::Structs: IsUnset,
Sourcepub fn maybe_structs(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetStructs<S>>where
S::Structs: IsUnset,
pub fn maybe_structs(
self,
value: Option<WithParamsRules>,
) -> ConfigBuilder<SetStructs<S>>where
S::Structs: IsUnset,
Sourcepub fn variables(self, value: VariableConfig) -> ConfigBuilder<SetVariables<S>>where
S::Variables: IsUnset,
pub fn variables(self, value: VariableConfig) -> ConfigBuilder<SetVariables<S>>where
S::Variables: IsUnset,
Sourcepub fn maybe_variables(
self,
value: Option<VariableConfig>,
) -> ConfigBuilder<SetVariables<S>>where
S::Variables: IsUnset,
pub fn maybe_variables(
self,
value: Option<VariableConfig>,
) -> ConfigBuilder<SetVariables<S>>where
S::Variables: IsUnset,
Auto Trait Implementations§
impl<S> Freeze for ConfigBuilder<S>
impl<S> RefUnwindSafe for ConfigBuilder<S>
impl<S> Send for ConfigBuilder<S>
impl<S> Sync for ConfigBuilder<S>
impl<S> Unpin for ConfigBuilder<S>
impl<S> UnsafeUnpin for ConfigBuilder<S>
impl<S> UnwindSafe for ConfigBuilder<S>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
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§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.