#[non_exhaustive]pub struct DataTransferProgressBuilder { /* private fields */ }
Expand description
A builder for DataTransferProgress
.
Implementations§
Source§impl DataTransferProgressBuilder
impl DataTransferProgressBuilder
Sourcepub fn status(self, input: impl Into<String>) -> Self
pub fn status(self, input: impl Into<String>) -> Self
Describes the status of the cluster. While the transfer is in progress the status is transferringdata
.
Sourcepub fn set_status(self, input: Option<String>) -> Self
pub fn set_status(self, input: Option<String>) -> Self
Describes the status of the cluster. While the transfer is in progress the status is transferringdata
.
Sourcepub fn get_status(&self) -> &Option<String>
pub fn get_status(&self) -> &Option<String>
Describes the status of the cluster. While the transfer is in progress the status is transferringdata
.
Sourcepub fn current_rate_in_mega_bytes_per_second(self, input: f64) -> Self
pub fn current_rate_in_mega_bytes_per_second(self, input: f64) -> Self
Describes the data transfer rate in MB's per second.
Sourcepub fn set_current_rate_in_mega_bytes_per_second(
self,
input: Option<f64>,
) -> Self
pub fn set_current_rate_in_mega_bytes_per_second( self, input: Option<f64>, ) -> Self
Describes the data transfer rate in MB's per second.
Sourcepub fn get_current_rate_in_mega_bytes_per_second(&self) -> &Option<f64>
pub fn get_current_rate_in_mega_bytes_per_second(&self) -> &Option<f64>
Describes the data transfer rate in MB's per second.
Sourcepub fn total_data_in_mega_bytes(self, input: i64) -> Self
pub fn total_data_in_mega_bytes(self, input: i64) -> Self
Describes the total amount of data to be transfered in megabytes.
Sourcepub fn set_total_data_in_mega_bytes(self, input: Option<i64>) -> Self
pub fn set_total_data_in_mega_bytes(self, input: Option<i64>) -> Self
Describes the total amount of data to be transfered in megabytes.
Sourcepub fn get_total_data_in_mega_bytes(&self) -> &Option<i64>
pub fn get_total_data_in_mega_bytes(&self) -> &Option<i64>
Describes the total amount of data to be transfered in megabytes.
Sourcepub fn data_transferred_in_mega_bytes(self, input: i64) -> Self
pub fn data_transferred_in_mega_bytes(self, input: i64) -> Self
Describes the total amount of data that has been transfered in MB's.
Sourcepub fn set_data_transferred_in_mega_bytes(self, input: Option<i64>) -> Self
pub fn set_data_transferred_in_mega_bytes(self, input: Option<i64>) -> Self
Describes the total amount of data that has been transfered in MB's.
Sourcepub fn get_data_transferred_in_mega_bytes(&self) -> &Option<i64>
pub fn get_data_transferred_in_mega_bytes(&self) -> &Option<i64>
Describes the total amount of data that has been transfered in MB's.
Sourcepub fn estimated_time_to_completion_in_seconds(self, input: i64) -> Self
pub fn estimated_time_to_completion_in_seconds(self, input: i64) -> Self
Describes the estimated number of seconds remaining to complete the transfer.
Sourcepub fn set_estimated_time_to_completion_in_seconds(
self,
input: Option<i64>,
) -> Self
pub fn set_estimated_time_to_completion_in_seconds( self, input: Option<i64>, ) -> Self
Describes the estimated number of seconds remaining to complete the transfer.
Sourcepub fn get_estimated_time_to_completion_in_seconds(&self) -> &Option<i64>
pub fn get_estimated_time_to_completion_in_seconds(&self) -> &Option<i64>
Describes the estimated number of seconds remaining to complete the transfer.
Sourcepub fn elapsed_time_in_seconds(self, input: i64) -> Self
pub fn elapsed_time_in_seconds(self, input: i64) -> Self
Describes the number of seconds that have elapsed during the data transfer.
Sourcepub fn set_elapsed_time_in_seconds(self, input: Option<i64>) -> Self
pub fn set_elapsed_time_in_seconds(self, input: Option<i64>) -> Self
Describes the number of seconds that have elapsed during the data transfer.
Sourcepub fn get_elapsed_time_in_seconds(&self) -> &Option<i64>
pub fn get_elapsed_time_in_seconds(&self) -> &Option<i64>
Describes the number of seconds that have elapsed during the data transfer.
Sourcepub fn build(self) -> DataTransferProgress
pub fn build(self) -> DataTransferProgress
Consumes the builder and constructs a DataTransferProgress
.
Trait Implementations§
Source§impl Clone for DataTransferProgressBuilder
impl Clone for DataTransferProgressBuilder
Source§fn clone(&self) -> DataTransferProgressBuilder
fn clone(&self) -> DataTransferProgressBuilder
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 DataTransferProgressBuilder
impl Debug for DataTransferProgressBuilder
Source§impl Default for DataTransferProgressBuilder
impl Default for DataTransferProgressBuilder
Source§fn default() -> DataTransferProgressBuilder
fn default() -> DataTransferProgressBuilder
Source§impl PartialEq for DataTransferProgressBuilder
impl PartialEq for DataTransferProgressBuilder
Source§fn eq(&self, other: &DataTransferProgressBuilder) -> bool
fn eq(&self, other: &DataTransferProgressBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DataTransferProgressBuilder
Auto Trait Implementations§
impl Freeze for DataTransferProgressBuilder
impl RefUnwindSafe for DataTransferProgressBuilder
impl Send for DataTransferProgressBuilder
impl Sync for DataTransferProgressBuilder
impl Unpin for DataTransferProgressBuilder
impl UnwindSafe for DataTransferProgressBuilder
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);