VisualBuilder

aws_sdk_quicksight::types::builders

Struct VisualBuilder 

Source 
#[non_exhaustive]
pub struct VisualBuilder { /* private fields */ }
Expand description

A builder for Visual.

Implementations§

Source§

impl VisualBuilder

Source

pub fn table_visual(self, input: TableVisual) -> Self

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

Source

pub fn set_table_visual(self, input: Option<TableVisual>) -> Self

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

Source

pub fn get_table_visual(&self) -> &Option<TableVisual>

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

Source

pub fn pivot_table_visual(self, input: PivotTableVisual) -> Self

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

Source

pub fn set_pivot_table_visual(self, input: Option<PivotTableVisual>) -> Self

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

Source

pub fn get_pivot_table_visual(&self) -> &Option<PivotTableVisual>

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

Source

pub fn bar_chart_visual(self, input: BarChartVisual) -> Self

A bar chart.

For more information, see Using bar charts in the Amazon QuickSight User Guide.

Source

pub fn set_bar_chart_visual(self, input: Option<BarChartVisual>) -> Self

A bar chart.

For more information, see Using bar charts in the Amazon QuickSight User Guide.

Source

pub fn get_bar_chart_visual(&self) -> &Option<BarChartVisual>

A bar chart.

For more information, see Using bar charts in the Amazon QuickSight User Guide.

Source

pub fn kpi_visual(self, input: KpiVisual) -> Self

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

Source

pub fn set_kpi_visual(self, input: Option<KpiVisual>) -> Self

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

Source

pub fn get_kpi_visual(&self) -> &Option<KpiVisual>

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

Source

pub fn pie_chart_visual(self, input: PieChartVisual) -> Self

A pie or donut chart.

For more information, see Using pie charts in the Amazon QuickSight User Guide.

Source

pub fn set_pie_chart_visual(self, input: Option<PieChartVisual>) -> Self

A pie or donut chart.

For more information, see Using pie charts in the Amazon QuickSight User Guide.

Source

pub fn get_pie_chart_visual(&self) -> &Option<PieChartVisual>

A pie or donut chart.

For more information, see Using pie charts in the Amazon QuickSight User Guide.

Source

pub fn gauge_chart_visual(self, input: GaugeChartVisual) -> Self

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

Source

pub fn set_gauge_chart_visual(self, input: Option<GaugeChartVisual>) -> Self

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

Source

pub fn get_gauge_chart_visual(&self) -> &Option<GaugeChartVisual>

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

Source

pub fn line_chart_visual(self, input: LineChartVisual) -> Self

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide.

Source

pub fn set_line_chart_visual(self, input: Option<LineChartVisual>) -> Self

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide.

Source

pub fn get_line_chart_visual(&self) -> &Option<LineChartVisual>

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide.

Source

pub fn heat_map_visual(self, input: HeatMapVisual) -> Self

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

Source

pub fn set_heat_map_visual(self, input: Option<HeatMapVisual>) -> Self

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

Source

pub fn get_heat_map_visual(&self) -> &Option<HeatMapVisual>

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

Source

pub fn tree_map_visual(self, input: TreeMapVisual) -> Self

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

Source

pub fn set_tree_map_visual(self, input: Option<TreeMapVisual>) -> Self

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

Source

pub fn get_tree_map_visual(&self) -> &Option<TreeMapVisual>

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

Source

pub fn geospatial_map_visual(self, input: GeospatialMapVisual) -> Self

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide.

Source

pub fn set_geospatial_map_visual( self, input: Option<GeospatialMapVisual>, ) -> Self

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide.

Source

pub fn get_geospatial_map_visual(&self) -> &Option<GeospatialMapVisual>

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide.

Source

pub fn filled_map_visual(self, input: FilledMapVisual) -> Self

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

Source

pub fn set_filled_map_visual(self, input: Option<FilledMapVisual>) -> Self

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

Source

pub fn get_filled_map_visual(&self) -> &Option<FilledMapVisual>

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

Source

pub fn layer_map_visual(self, input: LayerMapVisual) -> Self

The properties for a layer map visual

Source

pub fn set_layer_map_visual(self, input: Option<LayerMapVisual>) -> Self

The properties for a layer map visual

Source

pub fn get_layer_map_visual(&self) -> &Option<LayerMapVisual>

The properties for a layer map visual

Source

pub fn funnel_chart_visual(self, input: FunnelChartVisual) -> Self

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

Source

pub fn set_funnel_chart_visual(self, input: Option<FunnelChartVisual>) -> Self

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

Source

pub fn get_funnel_chart_visual(&self) -> &Option<FunnelChartVisual>

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

Source

pub fn scatter_plot_visual(self, input: ScatterPlotVisual) -> Self

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

Source

pub fn set_scatter_plot_visual(self, input: Option<ScatterPlotVisual>) -> Self

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

Source

pub fn get_scatter_plot_visual(&self) -> &Option<ScatterPlotVisual>

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

Source

pub fn combo_chart_visual(self, input: ComboChartVisual) -> Self

A combo chart.

For more information, see Using combo charts in the Amazon QuickSight User Guide.

Source

pub fn set_combo_chart_visual(self, input: Option<ComboChartVisual>) -> Self

A combo chart.

For more information, see Using combo charts in the Amazon QuickSight User Guide.

Source

pub fn get_combo_chart_visual(&self) -> &Option<ComboChartVisual>

A combo chart.

For more information, see Using combo charts in the Amazon QuickSight User Guide.

Source

pub fn box_plot_visual(self, input: BoxPlotVisual) -> Self

A box plot.

For more information, see Using box plots in the Amazon QuickSight User Guide.

Source

pub fn set_box_plot_visual(self, input: Option<BoxPlotVisual>) -> Self

A box plot.

For more information, see Using box plots in the Amazon QuickSight User Guide.

Source

pub fn get_box_plot_visual(&self) -> &Option<BoxPlotVisual>

A box plot.

For more information, see Using box plots in the Amazon QuickSight User Guide.

Source

pub fn waterfall_visual(self, input: WaterfallVisual) -> Self

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

Source

pub fn set_waterfall_visual(self, input: Option<WaterfallVisual>) -> Self

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

Source

pub fn get_waterfall_visual(&self) -> &Option<WaterfallVisual>

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

Source

pub fn histogram_visual(self, input: HistogramVisual) -> Self

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

Source

pub fn set_histogram_visual(self, input: Option<HistogramVisual>) -> Self

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

Source

pub fn get_histogram_visual(&self) -> &Option<HistogramVisual>

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

Source

pub fn word_cloud_visual(self, input: WordCloudVisual) -> Self

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

Source

pub fn set_word_cloud_visual(self, input: Option<WordCloudVisual>) -> Self

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

Source

pub fn get_word_cloud_visual(&self) -> &Option<WordCloudVisual>

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

Source

pub fn insight_visual(self, input: InsightVisual) -> Self

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

Source

pub fn set_insight_visual(self, input: Option<InsightVisual>) -> Self

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

Source

pub fn get_insight_visual(&self) -> &Option<InsightVisual>

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

Source

pub fn sankey_diagram_visual(self, input: SankeyDiagramVisual) -> Self

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

Source

pub fn set_sankey_diagram_visual( self, input: Option<SankeyDiagramVisual>, ) -> Self

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

Source

pub fn get_sankey_diagram_visual(&self) -> &Option<SankeyDiagramVisual>

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

Source

pub fn custom_content_visual(self, input: CustomContentVisual) -> Self

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

Source

pub fn set_custom_content_visual( self, input: Option<CustomContentVisual>, ) -> Self

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

Source

pub fn get_custom_content_visual(&self) -> &Option<CustomContentVisual>

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

Source

pub fn empty_visual(self, input: EmptyVisual) -> Self

An empty visual.

Source

pub fn set_empty_visual(self, input: Option<EmptyVisual>) -> Self

An empty visual.

Source

pub fn get_empty_visual(&self) -> &Option<EmptyVisual>

An empty visual.

Source

pub fn radar_chart_visual(self, input: RadarChartVisual) -> Self

A radar chart visual.

For more information, see Using radar charts in the Amazon QuickSight User Guide.

Source

pub fn set_radar_chart_visual(self, input: Option<RadarChartVisual>) -> Self

A radar chart visual.

For more information, see Using radar charts in the Amazon QuickSight User Guide.

Source

pub fn get_radar_chart_visual(&self) -> &Option<RadarChartVisual>

A radar chart visual.

For more information, see Using radar charts in the Amazon QuickSight User Guide.

Source

pub fn plugin_visual(self, input: PluginVisual) -> Self

The custom plugin visual type.

Source

pub fn set_plugin_visual(self, input: Option<PluginVisual>) -> Self

The custom plugin visual type.

Source

pub fn get_plugin_visual(&self) -> &Option<PluginVisual>

The custom plugin visual type.

Source

pub fn build(self) -> Visual

Consumes the builder and constructs a Visual.

Trait Implementations§

Source§

impl Clone for VisualBuilder

Source§

fn clone(&self) -> VisualBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for VisualBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for VisualBuilder

Source§

fn default() -> VisualBuilder

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

impl PartialEq for VisualBuilder

Source§

fn eq(&self, other: &VisualBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for VisualBuilder

Auto Trait Implementations§

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

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));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

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>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

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>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

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>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

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>

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

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));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

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>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

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>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

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>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

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>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

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());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
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
Source§

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