#[non_exhaustive]pub struct CustomContentConfigurationBuilder { /* private fields */ }Expand description
A builder for CustomContentConfiguration.
Implementations§
Source§impl CustomContentConfigurationBuilder
impl CustomContentConfigurationBuilder
Sourcepub fn content_url(self, input: impl Into<String>) -> Self
pub fn content_url(self, input: impl Into<String>) -> Self
The input URL that links to the custom content that you want in the custom visual.
Sourcepub fn set_content_url(self, input: Option<String>) -> Self
pub fn set_content_url(self, input: Option<String>) -> Self
The input URL that links to the custom content that you want in the custom visual.
Sourcepub fn get_content_url(&self) -> &Option<String>
pub fn get_content_url(&self) -> &Option<String>
The input URL that links to the custom content that you want in the custom visual.
Sourcepub fn content_type(self, input: CustomContentType) -> Self
pub fn content_type(self, input: CustomContentType) -> Self
The content type of the custom content visual. You can use this to have the visual render as an image.
Sourcepub fn set_content_type(self, input: Option<CustomContentType>) -> Self
pub fn set_content_type(self, input: Option<CustomContentType>) -> Self
The content type of the custom content visual. You can use this to have the visual render as an image.
Sourcepub fn get_content_type(&self) -> &Option<CustomContentType>
pub fn get_content_type(&self) -> &Option<CustomContentType>
The content type of the custom content visual. You can use this to have the visual render as an image.
Sourcepub fn image_scaling(
self,
input: CustomContentImageScalingConfiguration,
) -> Self
pub fn image_scaling( self, input: CustomContentImageScalingConfiguration, ) -> Self
The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.
Sourcepub fn set_image_scaling(
self,
input: Option<CustomContentImageScalingConfiguration>,
) -> Self
pub fn set_image_scaling( self, input: Option<CustomContentImageScalingConfiguration>, ) -> Self
The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.
Sourcepub fn get_image_scaling(
&self,
) -> &Option<CustomContentImageScalingConfiguration>
pub fn get_image_scaling( &self, ) -> &Option<CustomContentImageScalingConfiguration>
The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.
Sourcepub fn interactions(self, input: VisualInteractionOptions) -> Self
pub fn interactions(self, input: VisualInteractionOptions) -> Self
The general visual interactions setup for a visual.
Sourcepub fn set_interactions(self, input: Option<VisualInteractionOptions>) -> Self
pub fn set_interactions(self, input: Option<VisualInteractionOptions>) -> Self
The general visual interactions setup for a visual.
Sourcepub fn get_interactions(&self) -> &Option<VisualInteractionOptions>
pub fn get_interactions(&self) -> &Option<VisualInteractionOptions>
The general visual interactions setup for a visual.
Sourcepub fn build(self) -> CustomContentConfiguration
pub fn build(self) -> CustomContentConfiguration
Consumes the builder and constructs a CustomContentConfiguration.
Trait Implementations§
Source§impl Clone for CustomContentConfigurationBuilder
impl Clone for CustomContentConfigurationBuilder
Source§fn clone(&self) -> CustomContentConfigurationBuilder
fn clone(&self) -> CustomContentConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for CustomContentConfigurationBuilder
impl Default for CustomContentConfigurationBuilder
Source§fn default() -> CustomContentConfigurationBuilder
fn default() -> CustomContentConfigurationBuilder
Source§impl PartialEq for CustomContentConfigurationBuilder
impl PartialEq for CustomContentConfigurationBuilder
Source§fn eq(&self, other: &CustomContentConfigurationBuilder) -> bool
fn eq(&self, other: &CustomContentConfigurationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for CustomContentConfigurationBuilder
Auto Trait Implementations§
impl Freeze for CustomContentConfigurationBuilder
impl RefUnwindSafe for CustomContentConfigurationBuilder
impl Send for CustomContentConfigurationBuilder
impl Sync for CustomContentConfigurationBuilder
impl Unpin for CustomContentConfigurationBuilder
impl UnwindSafe for CustomContentConfigurationBuilder
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);