#[non_exhaustive]pub struct PluginVisualBuilder { /* private fields */ }
Expand description
A builder for PluginVisual
.
Implementations§
Source§impl PluginVisualBuilder
impl PluginVisualBuilder
Sourcepub fn visual_id(self, input: impl Into<String>) -> Self
pub fn visual_id(self, input: impl Into<String>) -> Self
The ID of the visual that you want to use.
This field is required.Sourcepub fn set_visual_id(self, input: Option<String>) -> Self
pub fn set_visual_id(self, input: Option<String>) -> Self
The ID of the visual that you want to use.
Sourcepub fn get_visual_id(&self) -> &Option<String>
pub fn get_visual_id(&self) -> &Option<String>
The ID of the visual that you want to use.
Sourcepub fn plugin_arn(self, input: impl Into<String>) -> Self
pub fn plugin_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) that reflects the plugin and version.
This field is required.Sourcepub fn set_plugin_arn(self, input: Option<String>) -> Self
pub fn set_plugin_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) that reflects the plugin and version.
Sourcepub fn get_plugin_arn(&self) -> &Option<String>
pub fn get_plugin_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) that reflects the plugin and version.
Sourcepub fn title(self, input: VisualTitleLabelOptions) -> Self
pub fn title(self, input: VisualTitleLabelOptions) -> Self
The title label options for a visual.
Sourcepub fn set_title(self, input: Option<VisualTitleLabelOptions>) -> Self
pub fn set_title(self, input: Option<VisualTitleLabelOptions>) -> Self
The title label options for a visual.
Sourcepub fn get_title(&self) -> &Option<VisualTitleLabelOptions>
pub fn get_title(&self) -> &Option<VisualTitleLabelOptions>
The title label options for a visual.
Sourcepub fn subtitle(self, input: VisualSubtitleLabelOptions) -> Self
pub fn subtitle(self, input: VisualSubtitleLabelOptions) -> Self
The subtitle label options for a visual.
Sourcepub fn set_subtitle(self, input: Option<VisualSubtitleLabelOptions>) -> Self
pub fn set_subtitle(self, input: Option<VisualSubtitleLabelOptions>) -> Self
The subtitle label options for a visual.
Sourcepub fn get_subtitle(&self) -> &Option<VisualSubtitleLabelOptions>
pub fn get_subtitle(&self) -> &Option<VisualSubtitleLabelOptions>
The subtitle label options for a visual.
Sourcepub fn chart_configuration(self, input: PluginVisualConfiguration) -> Self
pub fn chart_configuration(self, input: PluginVisualConfiguration) -> Self
A description of the plugin field wells and their persisted properties.
Sourcepub fn set_chart_configuration(
self,
input: Option<PluginVisualConfiguration>,
) -> Self
pub fn set_chart_configuration( self, input: Option<PluginVisualConfiguration>, ) -> Self
A description of the plugin field wells and their persisted properties.
Sourcepub fn get_chart_configuration(&self) -> &Option<PluginVisualConfiguration>
pub fn get_chart_configuration(&self) -> &Option<PluginVisualConfiguration>
A description of the plugin field wells and their persisted properties.
Sourcepub fn visual_content_alt_text(self, input: impl Into<String>) -> Self
pub fn visual_content_alt_text(self, input: impl Into<String>) -> Self
The alt text for the visual.
Sourcepub fn set_visual_content_alt_text(self, input: Option<String>) -> Self
pub fn set_visual_content_alt_text(self, input: Option<String>) -> Self
The alt text for the visual.
Sourcepub fn get_visual_content_alt_text(&self) -> &Option<String>
pub fn get_visual_content_alt_text(&self) -> &Option<String>
The alt text for the visual.
Sourcepub fn build(self) -> Result<PluginVisual, BuildError>
pub fn build(self) -> Result<PluginVisual, BuildError>
Consumes the builder and constructs a PluginVisual
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for PluginVisualBuilder
impl Clone for PluginVisualBuilder
Source§fn clone(&self) -> PluginVisualBuilder
fn clone(&self) -> PluginVisualBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PluginVisualBuilder
impl Debug for PluginVisualBuilder
Source§impl Default for PluginVisualBuilder
impl Default for PluginVisualBuilder
Source§fn default() -> PluginVisualBuilder
fn default() -> PluginVisualBuilder
Source§impl PartialEq for PluginVisualBuilder
impl PartialEq for PluginVisualBuilder
impl StructuralPartialEq for PluginVisualBuilder
Auto Trait Implementations§
impl Freeze for PluginVisualBuilder
impl RefUnwindSafe for PluginVisualBuilder
impl Send for PluginVisualBuilder
impl Sync for PluginVisualBuilder
impl Unpin for PluginVisualBuilder
impl UnwindSafe for PluginVisualBuilder
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§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>
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);