#[non_exhaustive]pub struct OverrideConfigurationBuilder { /* private fields */ }
Expand description
A builder for OverrideConfiguration
.
Implementations§
Source§impl OverrideConfigurationBuilder
impl OverrideConfigurationBuilder
Sourcepub fn document(self, input: DocumentOverrideConfiguration) -> Self
pub fn document(self, input: DocumentOverrideConfiguration) -> Self
Override Configuration of Document
Sourcepub fn set_document(self, input: Option<DocumentOverrideConfiguration>) -> Self
pub fn set_document(self, input: Option<DocumentOverrideConfiguration>) -> Self
Override Configuration of Document
Sourcepub fn get_document(&self) -> &Option<DocumentOverrideConfiguration>
pub fn get_document(&self) -> &Option<DocumentOverrideConfiguration>
Override Configuration of Document
Sourcepub fn image(self, input: ImageOverrideConfiguration) -> Self
pub fn image(self, input: ImageOverrideConfiguration) -> Self
Override Configuration of Image
Sourcepub fn set_image(self, input: Option<ImageOverrideConfiguration>) -> Self
pub fn set_image(self, input: Option<ImageOverrideConfiguration>) -> Self
Override Configuration of Image
Sourcepub fn get_image(&self) -> &Option<ImageOverrideConfiguration>
pub fn get_image(&self) -> &Option<ImageOverrideConfiguration>
Override Configuration of Image
Sourcepub fn video(self, input: VideoOverrideConfiguration) -> Self
pub fn video(self, input: VideoOverrideConfiguration) -> Self
Override Configuration of Video
Sourcepub fn set_video(self, input: Option<VideoOverrideConfiguration>) -> Self
pub fn set_video(self, input: Option<VideoOverrideConfiguration>) -> Self
Override Configuration of Video
Sourcepub fn get_video(&self) -> &Option<VideoOverrideConfiguration>
pub fn get_video(&self) -> &Option<VideoOverrideConfiguration>
Override Configuration of Video
Sourcepub fn audio(self, input: AudioOverrideConfiguration) -> Self
pub fn audio(self, input: AudioOverrideConfiguration) -> Self
Override Configuration of Audio
Sourcepub fn set_audio(self, input: Option<AudioOverrideConfiguration>) -> Self
pub fn set_audio(self, input: Option<AudioOverrideConfiguration>) -> Self
Override Configuration of Audio
Sourcepub fn get_audio(&self) -> &Option<AudioOverrideConfiguration>
pub fn get_audio(&self) -> &Option<AudioOverrideConfiguration>
Override Configuration of Audio
Sourcepub fn modality_routing(self, input: ModalityRoutingConfiguration) -> Self
pub fn modality_routing(self, input: ModalityRoutingConfiguration) -> Self
Configuration for routing file type to desired modality
Sourcepub fn set_modality_routing(
self,
input: Option<ModalityRoutingConfiguration>,
) -> Self
pub fn set_modality_routing( self, input: Option<ModalityRoutingConfiguration>, ) -> Self
Configuration for routing file type to desired modality
Sourcepub fn get_modality_routing(&self) -> &Option<ModalityRoutingConfiguration>
pub fn get_modality_routing(&self) -> &Option<ModalityRoutingConfiguration>
Configuration for routing file type to desired modality
Sourcepub fn build(self) -> OverrideConfiguration
pub fn build(self) -> OverrideConfiguration
Consumes the builder and constructs a OverrideConfiguration
.
Trait Implementations§
Source§impl Clone for OverrideConfigurationBuilder
impl Clone for OverrideConfigurationBuilder
Source§fn clone(&self) -> OverrideConfigurationBuilder
fn clone(&self) -> OverrideConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OverrideConfigurationBuilder
impl Debug for OverrideConfigurationBuilder
Source§impl Default for OverrideConfigurationBuilder
impl Default for OverrideConfigurationBuilder
Source§fn default() -> OverrideConfigurationBuilder
fn default() -> OverrideConfigurationBuilder
Source§impl PartialEq for OverrideConfigurationBuilder
impl PartialEq for OverrideConfigurationBuilder
Source§fn eq(&self, other: &OverrideConfigurationBuilder) -> bool
fn eq(&self, other: &OverrideConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for OverrideConfigurationBuilder
Auto Trait Implementations§
impl Freeze for OverrideConfigurationBuilder
impl RefUnwindSafe for OverrideConfigurationBuilder
impl Send for OverrideConfigurationBuilder
impl Sync for OverrideConfigurationBuilder
impl Unpin for OverrideConfigurationBuilder
impl UnwindSafe for OverrideConfigurationBuilder
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);