#[non_exhaustive]pub struct ProgressBuilder { /* private fields */ }Expand description
A builder for Progress.
Implementations§
Source§impl ProgressBuilder
impl ProgressBuilder
Sourcepub fn progress_percent(self, input: f64) -> Self
pub fn progress_percent(self, input: f64) -> Self
The percent complete for the current step of the schema conversion operation.
Sourcepub fn set_progress_percent(self, input: Option<f64>) -> Self
pub fn set_progress_percent(self, input: Option<f64>) -> Self
The percent complete for the current step of the schema conversion operation.
Sourcepub fn get_progress_percent(&self) -> &Option<f64>
pub fn get_progress_percent(&self) -> &Option<f64>
The percent complete for the current step of the schema conversion operation.
Sourcepub fn total_objects(self, input: i64) -> Self
pub fn total_objects(self, input: i64) -> Self
The number of objects in this schema conversion operation.
Sourcepub fn set_total_objects(self, input: Option<i64>) -> Self
pub fn set_total_objects(self, input: Option<i64>) -> Self
The number of objects in this schema conversion operation.
Sourcepub fn get_total_objects(&self) -> &Option<i64>
pub fn get_total_objects(&self) -> &Option<i64>
The number of objects in this schema conversion operation.
Sourcepub fn progress_step(self, input: impl Into<String>) -> Self
pub fn progress_step(self, input: impl Into<String>) -> Self
The step of the schema conversion operation. This parameter can store one of the following values:
-
IN_PROGRESS– The operation is running. -
LOADING_METADATA– Loads metadata from the source database. -
COUNTING_OBJECTS– Determines the number of objects involved in the operation. -
ANALYZING– Analyzes the source database objects. -
CONVERTING– Converts the source database objects to a format compatible with the target database. -
APPLYING– Applies the converted code to the target database. -
FINISHED– The operation completed successfully.
Sourcepub fn set_progress_step(self, input: Option<String>) -> Self
pub fn set_progress_step(self, input: Option<String>) -> Self
The step of the schema conversion operation. This parameter can store one of the following values:
-
IN_PROGRESS– The operation is running. -
LOADING_METADATA– Loads metadata from the source database. -
COUNTING_OBJECTS– Determines the number of objects involved in the operation. -
ANALYZING– Analyzes the source database objects. -
CONVERTING– Converts the source database objects to a format compatible with the target database. -
APPLYING– Applies the converted code to the target database. -
FINISHED– The operation completed successfully.
Sourcepub fn get_progress_step(&self) -> &Option<String>
pub fn get_progress_step(&self) -> &Option<String>
The step of the schema conversion operation. This parameter can store one of the following values:
-
IN_PROGRESS– The operation is running. -
LOADING_METADATA– Loads metadata from the source database. -
COUNTING_OBJECTS– Determines the number of objects involved in the operation. -
ANALYZING– Analyzes the source database objects. -
CONVERTING– Converts the source database objects to a format compatible with the target database. -
APPLYING– Applies the converted code to the target database. -
FINISHED– The operation completed successfully.
Sourcepub fn processed_object(self, input: ProcessedObject) -> Self
pub fn processed_object(self, input: ProcessedObject) -> Self
The name of the database object that the schema conversion operation currently uses.
Sourcepub fn set_processed_object(self, input: Option<ProcessedObject>) -> Self
pub fn set_processed_object(self, input: Option<ProcessedObject>) -> Self
The name of the database object that the schema conversion operation currently uses.
Sourcepub fn get_processed_object(&self) -> &Option<ProcessedObject>
pub fn get_processed_object(&self) -> &Option<ProcessedObject>
The name of the database object that the schema conversion operation currently uses.
Trait Implementations§
Source§impl Clone for ProgressBuilder
impl Clone for ProgressBuilder
Source§fn clone(&self) -> ProgressBuilder
fn clone(&self) -> ProgressBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ProgressBuilder
impl Debug for ProgressBuilder
Source§impl Default for ProgressBuilder
impl Default for ProgressBuilder
Source§fn default() -> ProgressBuilder
fn default() -> ProgressBuilder
Source§impl PartialEq for ProgressBuilder
impl PartialEq for ProgressBuilder
impl StructuralPartialEq for ProgressBuilder
Auto Trait Implementations§
impl Freeze for ProgressBuilder
impl RefUnwindSafe for ProgressBuilder
impl Send for ProgressBuilder
impl Sync for ProgressBuilder
impl Unpin for ProgressBuilder
impl UnwindSafe for ProgressBuilder
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);