#[non_exhaustive]pub struct LayoutConfigurationBuilder { /* private fields */ }
Expand description
A builder for LayoutConfiguration
.
Implementations§
Source§impl LayoutConfigurationBuilder
impl LayoutConfigurationBuilder
Sourcepub fn grid_layout(self, input: GridLayoutConfiguration) -> Self
pub fn grid_layout(self, input: GridLayoutConfiguration) -> Self
A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED
or RESPONSIVE
.
Sourcepub fn set_grid_layout(self, input: Option<GridLayoutConfiguration>) -> Self
pub fn set_grid_layout(self, input: Option<GridLayoutConfiguration>) -> Self
A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED
or RESPONSIVE
.
Sourcepub fn get_grid_layout(&self) -> &Option<GridLayoutConfiguration>
pub fn get_grid_layout(&self) -> &Option<GridLayoutConfiguration>
A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED
or RESPONSIVE
.
Sourcepub fn free_form_layout(self, input: FreeFormLayoutConfiguration) -> Self
pub fn free_form_layout(self, input: FreeFormLayoutConfiguration) -> Self
A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
Sourcepub fn set_free_form_layout(
self,
input: Option<FreeFormLayoutConfiguration>,
) -> Self
pub fn set_free_form_layout( self, input: Option<FreeFormLayoutConfiguration>, ) -> Self
A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
Sourcepub fn get_free_form_layout(&self) -> &Option<FreeFormLayoutConfiguration>
pub fn get_free_form_layout(&self) -> &Option<FreeFormLayoutConfiguration>
A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
Sourcepub fn section_based_layout(
self,
input: SectionBasedLayoutConfiguration,
) -> Self
pub fn section_based_layout( self, input: SectionBasedLayoutConfiguration, ) -> Self
A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
Sourcepub fn set_section_based_layout(
self,
input: Option<SectionBasedLayoutConfiguration>,
) -> Self
pub fn set_section_based_layout( self, input: Option<SectionBasedLayoutConfiguration>, ) -> Self
A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
Sourcepub fn get_section_based_layout(
&self,
) -> &Option<SectionBasedLayoutConfiguration>
pub fn get_section_based_layout( &self, ) -> &Option<SectionBasedLayoutConfiguration>
A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
Sourcepub fn build(self) -> LayoutConfiguration
pub fn build(self) -> LayoutConfiguration
Consumes the builder and constructs a LayoutConfiguration
.
Trait Implementations§
Source§impl Clone for LayoutConfigurationBuilder
impl Clone for LayoutConfigurationBuilder
Source§fn clone(&self) -> LayoutConfigurationBuilder
fn clone(&self) -> LayoutConfigurationBuilder
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 LayoutConfigurationBuilder
impl Debug for LayoutConfigurationBuilder
Source§impl Default for LayoutConfigurationBuilder
impl Default for LayoutConfigurationBuilder
Source§fn default() -> LayoutConfigurationBuilder
fn default() -> LayoutConfigurationBuilder
Source§impl PartialEq for LayoutConfigurationBuilder
impl PartialEq for LayoutConfigurationBuilder
Source§fn eq(&self, other: &LayoutConfigurationBuilder) -> bool
fn eq(&self, other: &LayoutConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for LayoutConfigurationBuilder
Auto Trait Implementations§
impl Freeze for LayoutConfigurationBuilder
impl RefUnwindSafe for LayoutConfigurationBuilder
impl Send for LayoutConfigurationBuilder
impl Sync for LayoutConfigurationBuilder
impl Unpin for LayoutConfigurationBuilder
impl UnwindSafe for LayoutConfigurationBuilder
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);