#[non_exhaustive]pub struct OverallVolumeBuilder { /* private fields */ }
Expand description
A builder for OverallVolume
.
Implementations§
Source§impl OverallVolumeBuilder
impl OverallVolumeBuilder
Sourcepub fn volume_statistics(self, input: VolumeStatistics) -> Self
pub fn volume_statistics(self, input: VolumeStatistics) -> Self
An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
Sourcepub fn set_volume_statistics(self, input: Option<VolumeStatistics>) -> Self
pub fn set_volume_statistics(self, input: Option<VolumeStatistics>) -> Self
An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
Sourcepub fn get_volume_statistics(&self) -> &Option<VolumeStatistics>
pub fn get_volume_statistics(&self) -> &Option<VolumeStatistics>
An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
Sourcepub fn read_rate_percent(self, input: f64) -> Self
pub fn read_rate_percent(self, input: f64) -> Self
The percentage of emails that were sent from the domain that were read by their recipients.
Sourcepub fn set_read_rate_percent(self, input: Option<f64>) -> Self
pub fn set_read_rate_percent(self, input: Option<f64>) -> Self
The percentage of emails that were sent from the domain that were read by their recipients.
Sourcepub fn get_read_rate_percent(&self) -> &Option<f64>
pub fn get_read_rate_percent(&self) -> &Option<f64>
The percentage of emails that were sent from the domain that were read by their recipients.
Sourcepub fn domain_isp_placements(self, input: DomainIspPlacement) -> Self
pub fn domain_isp_placements(self, input: DomainIspPlacement) -> Self
Appends an item to domain_isp_placements
.
To override the contents of this collection use set_domain_isp_placements
.
An object that contains inbox and junk mail placement metrics for individual email providers.
Sourcepub fn set_domain_isp_placements(
self,
input: Option<Vec<DomainIspPlacement>>,
) -> Self
pub fn set_domain_isp_placements( self, input: Option<Vec<DomainIspPlacement>>, ) -> Self
An object that contains inbox and junk mail placement metrics for individual email providers.
Sourcepub fn get_domain_isp_placements(&self) -> &Option<Vec<DomainIspPlacement>>
pub fn get_domain_isp_placements(&self) -> &Option<Vec<DomainIspPlacement>>
An object that contains inbox and junk mail placement metrics for individual email providers.
Sourcepub fn build(self) -> OverallVolume
pub fn build(self) -> OverallVolume
Consumes the builder and constructs a OverallVolume
.
Trait Implementations§
Source§impl Clone for OverallVolumeBuilder
impl Clone for OverallVolumeBuilder
Source§fn clone(&self) -> OverallVolumeBuilder
fn clone(&self) -> OverallVolumeBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OverallVolumeBuilder
impl Debug for OverallVolumeBuilder
Source§impl Default for OverallVolumeBuilder
impl Default for OverallVolumeBuilder
Source§fn default() -> OverallVolumeBuilder
fn default() -> OverallVolumeBuilder
Source§impl PartialEq for OverallVolumeBuilder
impl PartialEq for OverallVolumeBuilder
impl StructuralPartialEq for OverallVolumeBuilder
Auto Trait Implementations§
impl Freeze for OverallVolumeBuilder
impl RefUnwindSafe for OverallVolumeBuilder
impl Send for OverallVolumeBuilder
impl Sync for OverallVolumeBuilder
impl Unpin for OverallVolumeBuilder
impl UnwindSafe for OverallVolumeBuilder
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);