#[non_exhaustive]pub struct VisualCustomActionBuilder { /* private fields */ }Expand description
A builder for VisualCustomAction.
Implementations§
source§impl VisualCustomActionBuilder
impl VisualCustomActionBuilder
sourcepub fn custom_action_id(self, input: impl Into<String>) -> Self
pub fn custom_action_id(self, input: impl Into<String>) -> Self
The ID of the VisualCustomAction.
sourcepub fn set_custom_action_id(self, input: Option<String>) -> Self
pub fn set_custom_action_id(self, input: Option<String>) -> Self
The ID of the VisualCustomAction.
sourcepub fn get_custom_action_id(&self) -> &Option<String>
pub fn get_custom_action_id(&self) -> &Option<String>
The ID of the VisualCustomAction.
sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the VisualCustomAction.
sourcepub fn status(self, input: WidgetStatus) -> Self
pub fn status(self, input: WidgetStatus) -> Self
The status of the VisualCustomAction.
sourcepub fn set_status(self, input: Option<WidgetStatus>) -> Self
pub fn set_status(self, input: Option<WidgetStatus>) -> Self
The status of the VisualCustomAction.
sourcepub fn get_status(&self) -> &Option<WidgetStatus>
pub fn get_status(&self) -> &Option<WidgetStatus>
The status of the VisualCustomAction.
sourcepub fn trigger(self, input: VisualCustomActionTrigger) -> Self
pub fn trigger(self, input: VisualCustomActionTrigger) -> Self
The trigger of the VisualCustomAction.
Valid values are defined as follows:
-
DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point. -
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
sourcepub fn set_trigger(self, input: Option<VisualCustomActionTrigger>) -> Self
pub fn set_trigger(self, input: Option<VisualCustomActionTrigger>) -> Self
The trigger of the VisualCustomAction.
Valid values are defined as follows:
-
DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point. -
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
sourcepub fn get_trigger(&self) -> &Option<VisualCustomActionTrigger>
pub fn get_trigger(&self) -> &Option<VisualCustomActionTrigger>
The trigger of the VisualCustomAction.
Valid values are defined as follows:
-
DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point. -
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
sourcepub fn action_operations(self, input: VisualCustomActionOperation) -> Self
pub fn action_operations(self, input: VisualCustomActionOperation) -> Self
Appends an item to action_operations.
To override the contents of this collection use set_action_operations.
A list of VisualCustomActionOperations.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
sourcepub fn set_action_operations(
self,
input: Option<Vec<VisualCustomActionOperation>>,
) -> Self
pub fn set_action_operations( self, input: Option<Vec<VisualCustomActionOperation>>, ) -> Self
A list of VisualCustomActionOperations.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
sourcepub fn get_action_operations(&self) -> &Option<Vec<VisualCustomActionOperation>>
pub fn get_action_operations(&self) -> &Option<Vec<VisualCustomActionOperation>>
A list of VisualCustomActionOperations.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
sourcepub fn build(self) -> Result<VisualCustomAction, BuildError>
pub fn build(self) -> Result<VisualCustomAction, BuildError>
Consumes the builder and constructs a VisualCustomAction.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for VisualCustomActionBuilder
impl Clone for VisualCustomActionBuilder
source§fn clone(&self) -> VisualCustomActionBuilder
fn clone(&self) -> VisualCustomActionBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for VisualCustomActionBuilder
impl Debug for VisualCustomActionBuilder
source§impl Default for VisualCustomActionBuilder
impl Default for VisualCustomActionBuilder
source§fn default() -> VisualCustomActionBuilder
fn default() -> VisualCustomActionBuilder
impl StructuralPartialEq for VisualCustomActionBuilder
Auto Trait Implementations§
impl Freeze for VisualCustomActionBuilder
impl RefUnwindSafe for VisualCustomActionBuilder
impl Send for VisualCustomActionBuilder
impl Sync for VisualCustomActionBuilder
impl Unpin for VisualCustomActionBuilder
impl UnwindSafe for VisualCustomActionBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit)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>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());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>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());source§fn bright_yellow(&self) -> Painted<&T>
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>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
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>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
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>
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>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());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>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());source§fn on_bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
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>
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());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>
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);