pub struct ProgressArgsBuilder<S: State = Empty> { /* private fields */ }Expand description
Use builder syntax to set the inputs and finish with build().
Implementations§
Source§impl<S: State> ProgressArgsBuilder<S>
impl<S: State> ProgressArgsBuilder<S>
Sourcepub fn build(self) -> ProgressArgswhere
S: IsComplete,
pub fn build(self) -> ProgressArgswhere
S: IsComplete,
Finish building and return the requested object
Sourcepub fn bytes_cached(self, value: i64) -> ProgressArgsBuilder<SetBytesCached<S>>where
S::BytesCached: IsUnset,
pub fn bytes_cached(self, value: i64) -> ProgressArgsBuilder<SetBytesCached<S>>where
S::BytesCached: IsUnset,
Sourcepub fn maybe_bytes_cached(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesCached<S>>where
S::BytesCached: IsUnset,
pub fn maybe_bytes_cached(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesCached<S>>where
S::BytesCached: IsUnset,
Sourcepub fn bytes_estimated(
self,
value: i64,
) -> ProgressArgsBuilder<SetBytesEstimated<S>>where
S::BytesEstimated: IsUnset,
pub fn bytes_estimated(
self,
value: i64,
) -> ProgressArgsBuilder<SetBytesEstimated<S>>where
S::BytesEstimated: IsUnset,
Sourcepub fn maybe_bytes_estimated(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesEstimated<S>>where
S::BytesEstimated: IsUnset,
pub fn maybe_bytes_estimated(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesEstimated<S>>where
S::BytesEstimated: IsUnset,
Sourcepub fn bytes_hashed(self, value: i64) -> ProgressArgsBuilder<SetBytesHashed<S>>where
S::BytesHashed: IsUnset,
pub fn bytes_hashed(self, value: i64) -> ProgressArgsBuilder<SetBytesHashed<S>>where
S::BytesHashed: IsUnset,
Sourcepub fn maybe_bytes_hashed(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesHashed<S>>where
S::BytesHashed: IsUnset,
pub fn maybe_bytes_hashed(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesHashed<S>>where
S::BytesHashed: IsUnset,
Sourcepub fn bytes_read(self, value: i64) -> ProgressArgsBuilder<SetBytesRead<S>>where
S::BytesRead: IsUnset,
pub fn bytes_read(self, value: i64) -> ProgressArgsBuilder<SetBytesRead<S>>where
S::BytesRead: IsUnset,
Sourcepub fn maybe_bytes_read(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesRead<S>>where
S::BytesRead: IsUnset,
pub fn maybe_bytes_read(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesRead<S>>where
S::BytesRead: IsUnset,
Sourcepub fn bytes_uploaded(
self,
value: i64,
) -> ProgressArgsBuilder<SetBytesUploaded<S>>where
S::BytesUploaded: IsUnset,
pub fn bytes_uploaded(
self,
value: i64,
) -> ProgressArgsBuilder<SetBytesUploaded<S>>where
S::BytesUploaded: IsUnset,
Sourcepub fn maybe_bytes_uploaded(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesUploaded<S>>where
S::BytesUploaded: IsUnset,
pub fn maybe_bytes_uploaded(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetBytesUploaded<S>>where
S::BytesUploaded: IsUnset,
Sourcepub fn current_path(
self,
value: String,
) -> ProgressArgsBuilder<SetCurrentPath<S>>where
S::CurrentPath: IsUnset,
pub fn current_path(
self,
value: String,
) -> ProgressArgsBuilder<SetCurrentPath<S>>where
S::CurrentPath: IsUnset,
Sourcepub fn maybe_current_path(
self,
value: Option<String>,
) -> ProgressArgsBuilder<SetCurrentPath<S>>where
S::CurrentPath: IsUnset,
pub fn maybe_current_path(
self,
value: Option<String>,
) -> ProgressArgsBuilder<SetCurrentPath<S>>where
S::CurrentPath: IsUnset,
Sourcepub fn errors(self, value: i64) -> ProgressArgsBuilder<SetErrors<S>>where
S::Errors: IsUnset,
pub fn errors(self, value: i64) -> ProgressArgsBuilder<SetErrors<S>>where
S::Errors: IsUnset,
Sourcepub fn maybe_errors(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetErrors<S>>where
S::Errors: IsUnset,
pub fn maybe_errors(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetErrors<S>>where
S::Errors: IsUnset,
Sourcepub fn extra(
self,
value: Map<String, Value>,
) -> ProgressArgsBuilder<SetExtra<S>>where
S::Extra: IsUnset,
pub fn extra(
self,
value: Map<String, Value>,
) -> ProgressArgsBuilder<SetExtra<S>>where
S::Extra: IsUnset,
Required.
Any further detail the backup engine emits. Canopy makes no commitment about its shape: it is stored and shown verbatim, never interpreted.
Sourcepub fn files_done(self, value: i64) -> ProgressArgsBuilder<SetFilesDone<S>>where
S::FilesDone: IsUnset,
pub fn files_done(self, value: i64) -> ProgressArgsBuilder<SetFilesDone<S>>where
S::FilesDone: IsUnset,
Sourcepub fn maybe_files_done(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetFilesDone<S>>where
S::FilesDone: IsUnset,
pub fn maybe_files_done(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetFilesDone<S>>where
S::FilesDone: IsUnset,
Sourcepub fn files_estimated(
self,
value: i64,
) -> ProgressArgsBuilder<SetFilesEstimated<S>>where
S::FilesEstimated: IsUnset,
pub fn files_estimated(
self,
value: i64,
) -> ProgressArgsBuilder<SetFilesEstimated<S>>where
S::FilesEstimated: IsUnset,
Sourcepub fn maybe_files_estimated(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetFilesEstimated<S>>where
S::FilesEstimated: IsUnset,
pub fn maybe_files_estimated(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetFilesEstimated<S>>where
S::FilesEstimated: IsUnset,
Sourcepub fn ignored_errors(
self,
value: i64,
) -> ProgressArgsBuilder<SetIgnoredErrors<S>>where
S::IgnoredErrors: IsUnset,
pub fn ignored_errors(
self,
value: i64,
) -> ProgressArgsBuilder<SetIgnoredErrors<S>>where
S::IgnoredErrors: IsUnset,
Sourcepub fn maybe_ignored_errors(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetIgnoredErrors<S>>where
S::IgnoredErrors: IsUnset,
pub fn maybe_ignored_errors(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetIgnoredErrors<S>>where
S::IgnoredErrors: IsUnset,
Sourcepub fn purpose(self, value: BackupPurpose) -> ProgressArgsBuilder<SetPurpose<S>>where
S::Purpose: IsUnset,
pub fn purpose(self, value: BackupPurpose) -> ProgressArgsBuilder<SetPurpose<S>>where
S::Purpose: IsUnset,
Sourcepub fn maybe_purpose(
self,
value: Option<BackupPurpose>,
) -> ProgressArgsBuilder<SetPurpose<S>>where
S::Purpose: IsUnset,
pub fn maybe_purpose(
self,
value: Option<BackupPurpose>,
) -> ProgressArgsBuilder<SetPurpose<S>>where
S::Purpose: IsUnset,
Sourcepub fn run_id(self, value: Uuid) -> ProgressArgsBuilder<SetRunId<S>>where
S::RunId: IsUnset,
pub fn run_id(self, value: Uuid) -> ProgressArgsBuilder<SetRunId<S>>where
S::RunId: IsUnset,
Required.
The run-uuid the client minted for this run — the same one it passes to
POST /backup-credentials and reports under at POST /backup-report.
Sourcepub fn s3_received_payload_bytes(
self,
value: i64,
) -> ProgressArgsBuilder<SetS3ReceivedPayloadBytes<S>>where
S::S3ReceivedPayloadBytes: IsUnset,
pub fn s3_received_payload_bytes(
self,
value: i64,
) -> ProgressArgsBuilder<SetS3ReceivedPayloadBytes<S>>where
S::S3ReceivedPayloadBytes: IsUnset,
Sourcepub fn maybe_s3_received_payload_bytes(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetS3ReceivedPayloadBytes<S>>where
S::S3ReceivedPayloadBytes: IsUnset,
pub fn maybe_s3_received_payload_bytes(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetS3ReceivedPayloadBytes<S>>where
S::S3ReceivedPayloadBytes: IsUnset,
Sourcepub fn s3_received_raw_bytes(
self,
value: i64,
) -> ProgressArgsBuilder<SetS3ReceivedRawBytes<S>>where
S::S3ReceivedRawBytes: IsUnset,
pub fn s3_received_raw_bytes(
self,
value: i64,
) -> ProgressArgsBuilder<SetS3ReceivedRawBytes<S>>where
S::S3ReceivedRawBytes: IsUnset,
Sourcepub fn maybe_s3_received_raw_bytes(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetS3ReceivedRawBytes<S>>where
S::S3ReceivedRawBytes: IsUnset,
pub fn maybe_s3_received_raw_bytes(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetS3ReceivedRawBytes<S>>where
S::S3ReceivedRawBytes: IsUnset,
Sourcepub fn s3_sent_payload_bytes(
self,
value: i64,
) -> ProgressArgsBuilder<SetS3SentPayloadBytes<S>>where
S::S3SentPayloadBytes: IsUnset,
pub fn s3_sent_payload_bytes(
self,
value: i64,
) -> ProgressArgsBuilder<SetS3SentPayloadBytes<S>>where
S::S3SentPayloadBytes: IsUnset,
Sourcepub fn maybe_s3_sent_payload_bytes(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetS3SentPayloadBytes<S>>where
S::S3SentPayloadBytes: IsUnset,
pub fn maybe_s3_sent_payload_bytes(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetS3SentPayloadBytes<S>>where
S::S3SentPayloadBytes: IsUnset,
Sourcepub fn s3_sent_raw_bytes(
self,
value: i64,
) -> ProgressArgsBuilder<SetS3SentRawBytes<S>>where
S::S3SentRawBytes: IsUnset,
pub fn s3_sent_raw_bytes(
self,
value: i64,
) -> ProgressArgsBuilder<SetS3SentRawBytes<S>>where
S::S3SentRawBytes: IsUnset,
Sourcepub fn maybe_s3_sent_raw_bytes(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetS3SentRawBytes<S>>where
S::S3SentRawBytes: IsUnset,
pub fn maybe_s3_sent_raw_bytes(
self,
value: Option<i64>,
) -> ProgressArgsBuilder<SetS3SentRawBytes<S>>where
S::S3SentRawBytes: IsUnset,
Sourcepub fn snapshot_taken_at(
self,
value: Timestamp,
) -> ProgressArgsBuilder<SetSnapshotTakenAt<S>>where
S::SnapshotTakenAt: IsUnset,
pub fn snapshot_taken_at(
self,
value: Timestamp,
) -> ProgressArgsBuilder<SetSnapshotTakenAt<S>>where
S::SnapshotTakenAt: IsUnset,
Optional (Some / Option setters). When this run froze the data it is backing up — the point in time the backup represents, as opposed to when its upload finishes. Send it as soon as it is known (before any transfer starts). Recorded once per run: the first value Canopy sees stands, whether it arrives here or on the report.
Sourcepub fn maybe_snapshot_taken_at(
self,
value: Option<Timestamp>,
) -> ProgressArgsBuilder<SetSnapshotTakenAt<S>>where
S::SnapshotTakenAt: IsUnset,
pub fn maybe_snapshot_taken_at(
self,
value: Option<Timestamp>,
) -> ProgressArgsBuilder<SetSnapshotTakenAt<S>>where
S::SnapshotTakenAt: IsUnset,
Optional (Some / Option setters). When this run froze the data it is backing up — the point in time the backup represents, as opposed to when its upload finishes. Send it as soon as it is known (before any transfer starts). Recorded once per run: the first value Canopy sees stands, whether it arrives here or on the report.
Sourcepub fn type_(self, value: String) -> ProgressArgsBuilder<SetType<S>>where
S::Type: IsUnset,
pub fn type_(self, value: String) -> ProgressArgsBuilder<SetType<S>>where
S::Type: IsUnset,
Required.
The backup type being run (e.g. tamanu-postgres).
Auto Trait Implementations§
impl<S> Freeze for ProgressArgsBuilder<S>
impl<S> RefUnwindSafe for ProgressArgsBuilder<S>
impl<S> Send for ProgressArgsBuilder<S>
impl<S> Sync for ProgressArgsBuilder<S>
impl<S> Unpin for ProgressArgsBuilder<S>
impl<S> UnsafeUnpin for ProgressArgsBuilder<S>
impl<S> UnwindSafe for ProgressArgsBuilder<S>
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
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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>
Converts
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>
Converts
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<D> OwoColorize for D
impl<D> OwoColorize for D
Source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Set the foreground color generically Read more
Source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Set the background color generically. Read more
Source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Change the foreground color to black
Source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Change the background color to black
Source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Change the foreground color to red
Source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Change the background color to red
Source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Change the foreground color to green
Source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Change the background color to green
Source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Change the foreground color to yellow
Source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Change the background color to yellow
Source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Change the foreground color to blue
Source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Change the background color to blue
Source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Change the foreground color to magenta
Source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Change the background color to magenta
Source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Change the foreground color to purple
Source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Change the background color to purple
Source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Change the foreground color to cyan
Source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Change the background color to cyan
Source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Change the foreground color to white
Source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Change the background color to white
Source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Change the foreground color to the terminal default
Source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Change the background color to the terminal default
Source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Change the foreground color to bright black
Source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Change the background color to bright black
Source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Change the foreground color to bright red
Source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Change the background color to bright red
Source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Change the foreground color to bright green
Source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Change the background color to bright green
Source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Change the foreground color to bright yellow
Source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Change the background color to bright yellow
Source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Change the foreground color to bright blue
Source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Change the background color to bright blue
Source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright magenta
Source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright magenta
Source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright purple
Source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright purple
Source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Change the foreground color to bright cyan
Source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Change the background color to bright cyan
Source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Change the foreground color to bright white
Source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Change the background color to bright white
Source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Make the text bold
Source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Make the text dim
Source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Make the text italicized
Source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Make the text underlined
Source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Make the text blink
Source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Make the text blink (but fast!)
Source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Swap the foreground and background colors
Hide the text
Source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Cross out the text
Source§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either
OwoColorize::fg or
a color-specific method, such as OwoColorize::green, Read moreSource§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either
OwoColorize::bg or
a color-specific method, such as OwoColorize::on_yellow, Read moreSource§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
Source§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
Source§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
Sets the foreground color to an RGB value.
Source§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
Sets the background color to an RGB value.