#[non_exhaustive]pub struct CrawlBuilder { /* private fields */ }
Expand description
A builder for Crawl
.
Implementations§
Source§impl CrawlBuilder
impl CrawlBuilder
Sourcepub fn state(self, input: CrawlState) -> Self
pub fn state(self, input: CrawlState) -> Self
The state of the crawler.
Sourcepub fn set_state(self, input: Option<CrawlState>) -> Self
pub fn set_state(self, input: Option<CrawlState>) -> Self
The state of the crawler.
Sourcepub fn get_state(&self) -> &Option<CrawlState>
pub fn get_state(&self) -> &Option<CrawlState>
The state of the crawler.
Sourcepub fn started_on(self, input: DateTime) -> Self
pub fn started_on(self, input: DateTime) -> Self
The date and time on which the crawl started.
Sourcepub fn set_started_on(self, input: Option<DateTime>) -> Self
pub fn set_started_on(self, input: Option<DateTime>) -> Self
The date and time on which the crawl started.
Sourcepub fn get_started_on(&self) -> &Option<DateTime>
pub fn get_started_on(&self) -> &Option<DateTime>
The date and time on which the crawl started.
Sourcepub fn completed_on(self, input: DateTime) -> Self
pub fn completed_on(self, input: DateTime) -> Self
The date and time on which the crawl completed.
Sourcepub fn set_completed_on(self, input: Option<DateTime>) -> Self
pub fn set_completed_on(self, input: Option<DateTime>) -> Self
The date and time on which the crawl completed.
Sourcepub fn get_completed_on(&self) -> &Option<DateTime>
pub fn get_completed_on(&self) -> &Option<DateTime>
The date and time on which the crawl completed.
Sourcepub fn error_message(self, input: impl Into<String>) -> Self
pub fn error_message(self, input: impl Into<String>) -> Self
The error message associated with the crawl.
Sourcepub fn set_error_message(self, input: Option<String>) -> Self
pub fn set_error_message(self, input: Option<String>) -> Self
The error message associated with the crawl.
Sourcepub fn get_error_message(&self) -> &Option<String>
pub fn get_error_message(&self) -> &Option<String>
The error message associated with the crawl.
Sourcepub fn log_group(self, input: impl Into<String>) -> Self
pub fn log_group(self, input: impl Into<String>) -> Self
The log group associated with the crawl.
Sourcepub fn set_log_group(self, input: Option<String>) -> Self
pub fn set_log_group(self, input: Option<String>) -> Self
The log group associated with the crawl.
Sourcepub fn get_log_group(&self) -> &Option<String>
pub fn get_log_group(&self) -> &Option<String>
The log group associated with the crawl.
Sourcepub fn log_stream(self, input: impl Into<String>) -> Self
pub fn log_stream(self, input: impl Into<String>) -> Self
The log stream associated with the crawl.
Sourcepub fn set_log_stream(self, input: Option<String>) -> Self
pub fn set_log_stream(self, input: Option<String>) -> Self
The log stream associated with the crawl.
Sourcepub fn get_log_stream(&self) -> &Option<String>
pub fn get_log_stream(&self) -> &Option<String>
The log stream associated with the crawl.
Trait Implementations§
Source§impl Clone for CrawlBuilder
impl Clone for CrawlBuilder
Source§fn clone(&self) -> CrawlBuilder
fn clone(&self) -> CrawlBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CrawlBuilder
impl Debug for CrawlBuilder
Source§impl Default for CrawlBuilder
impl Default for CrawlBuilder
Source§fn default() -> CrawlBuilder
fn default() -> CrawlBuilder
Source§impl PartialEq for CrawlBuilder
impl PartialEq for CrawlBuilder
impl StructuralPartialEq for CrawlBuilder
Auto Trait Implementations§
impl Freeze for CrawlBuilder
impl RefUnwindSafe for CrawlBuilder
impl Send for CrawlBuilder
impl Sync for CrawlBuilder
impl Unpin for CrawlBuilder
impl UnwindSafe for CrawlBuilder
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);