#[non_exhaustive]pub struct BodySectionConfigurationBuilder { /* private fields */ }
Expand description
A builder for BodySectionConfiguration
.
Implementations§
Source§impl BodySectionConfigurationBuilder
impl BodySectionConfigurationBuilder
Sourcepub fn section_id(self, input: impl Into<String>) -> Self
pub fn section_id(self, input: impl Into<String>) -> Self
The unique identifier of a body section.
This field is required.Sourcepub fn set_section_id(self, input: Option<String>) -> Self
pub fn set_section_id(self, input: Option<String>) -> Self
The unique identifier of a body section.
Sourcepub fn get_section_id(&self) -> &Option<String>
pub fn get_section_id(&self) -> &Option<String>
The unique identifier of a body section.
Sourcepub fn content(self, input: BodySectionContent) -> Self
pub fn content(self, input: BodySectionContent) -> Self
The configuration of content in a body section.
This field is required.Sourcepub fn set_content(self, input: Option<BodySectionContent>) -> Self
pub fn set_content(self, input: Option<BodySectionContent>) -> Self
The configuration of content in a body section.
Sourcepub fn get_content(&self) -> &Option<BodySectionContent>
pub fn get_content(&self) -> &Option<BodySectionContent>
The configuration of content in a body section.
Sourcepub fn style(self, input: SectionStyle) -> Self
pub fn style(self, input: SectionStyle) -> Self
The style options of a body section.
Sourcepub fn set_style(self, input: Option<SectionStyle>) -> Self
pub fn set_style(self, input: Option<SectionStyle>) -> Self
The style options of a body section.
Sourcepub fn get_style(&self) -> &Option<SectionStyle>
pub fn get_style(&self) -> &Option<SectionStyle>
The style options of a body section.
Sourcepub fn page_break_configuration(
self,
input: SectionPageBreakConfiguration,
) -> Self
pub fn page_break_configuration( self, input: SectionPageBreakConfiguration, ) -> Self
The configuration of a page break for a section.
Sourcepub fn set_page_break_configuration(
self,
input: Option<SectionPageBreakConfiguration>,
) -> Self
pub fn set_page_break_configuration( self, input: Option<SectionPageBreakConfiguration>, ) -> Self
The configuration of a page break for a section.
Sourcepub fn get_page_break_configuration(
&self,
) -> &Option<SectionPageBreakConfiguration>
pub fn get_page_break_configuration( &self, ) -> &Option<SectionPageBreakConfiguration>
The configuration of a page break for a section.
Sourcepub fn repeat_configuration(self, input: BodySectionRepeatConfiguration) -> Self
pub fn repeat_configuration(self, input: BodySectionRepeatConfiguration) -> Self
Describes the configurations that are required to declare a section as repeating.
Sourcepub fn set_repeat_configuration(
self,
input: Option<BodySectionRepeatConfiguration>,
) -> Self
pub fn set_repeat_configuration( self, input: Option<BodySectionRepeatConfiguration>, ) -> Self
Describes the configurations that are required to declare a section as repeating.
Sourcepub fn get_repeat_configuration(
&self,
) -> &Option<BodySectionRepeatConfiguration>
pub fn get_repeat_configuration( &self, ) -> &Option<BodySectionRepeatConfiguration>
Describes the configurations that are required to declare a section as repeating.
Sourcepub fn build(self) -> Result<BodySectionConfiguration, BuildError>
pub fn build(self) -> Result<BodySectionConfiguration, BuildError>
Consumes the builder and constructs a BodySectionConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for BodySectionConfigurationBuilder
impl Clone for BodySectionConfigurationBuilder
Source§fn clone(&self) -> BodySectionConfigurationBuilder
fn clone(&self) -> BodySectionConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for BodySectionConfigurationBuilder
impl Default for BodySectionConfigurationBuilder
Source§fn default() -> BodySectionConfigurationBuilder
fn default() -> BodySectionConfigurationBuilder
Source§impl PartialEq for BodySectionConfigurationBuilder
impl PartialEq for BodySectionConfigurationBuilder
Source§fn eq(&self, other: &BodySectionConfigurationBuilder) -> bool
fn eq(&self, other: &BodySectionConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for BodySectionConfigurationBuilder
Auto Trait Implementations§
impl Freeze for BodySectionConfigurationBuilder
impl RefUnwindSafe for BodySectionConfigurationBuilder
impl Send for BodySectionConfigurationBuilder
impl Sync for BodySectionConfigurationBuilder
impl Unpin for BodySectionConfigurationBuilder
impl UnwindSafe for BodySectionConfigurationBuilder
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);