#[non_exhaustive]pub struct LogPatternBuilder { /* private fields */ }
Expand description
A builder for LogPattern
.
Implementations§
Source§impl LogPatternBuilder
impl LogPatternBuilder
Sourcepub fn pattern_set_name(self, input: impl Into<String>) -> Self
pub fn pattern_set_name(self, input: impl Into<String>) -> Self
The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Sourcepub fn set_pattern_set_name(self, input: Option<String>) -> Self
pub fn set_pattern_set_name(self, input: Option<String>) -> Self
The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Sourcepub fn get_pattern_set_name(&self) -> &Option<String>
pub fn get_pattern_set_name(&self) -> &Option<String>
The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Sourcepub fn pattern_name(self, input: impl Into<String>) -> Self
pub fn pattern_name(self, input: impl Into<String>) -> Self
The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Sourcepub fn set_pattern_name(self, input: Option<String>) -> Self
pub fn set_pattern_name(self, input: Option<String>) -> Self
The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Sourcepub fn get_pattern_name(&self) -> &Option<String>
pub fn get_pattern_name(&self) -> &Option<String>
The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Sourcepub fn pattern(self, input: impl Into<String>) -> Self
pub fn pattern(self, input: impl Into<String>) -> Self
A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
Sourcepub fn set_pattern(self, input: Option<String>) -> Self
pub fn set_pattern(self, input: Option<String>) -> Self
A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
Sourcepub fn get_pattern(&self) -> &Option<String>
pub fn get_pattern(&self) -> &Option<String>
A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
Sourcepub fn rank(self, input: i32) -> Self
pub fn rank(self, input: i32) -> Self
Rank of the log pattern. Must be a value between 1
and 1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1
will be the first to get matched to a log line. A pattern of rank 1,000,000
will be last to get matched. When you configure custom log patterns from the console, a Low
severity pattern translates to a 750,000
rank. A Medium
severity pattern translates to a 500,000
rank. And a High
severity pattern translates to a 250,000
rank. Rank values less than 1
or greater than 1,000,000
are reserved for Amazon Web Services provided patterns.
Sourcepub fn set_rank(self, input: Option<i32>) -> Self
pub fn set_rank(self, input: Option<i32>) -> Self
Rank of the log pattern. Must be a value between 1
and 1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1
will be the first to get matched to a log line. A pattern of rank 1,000,000
will be last to get matched. When you configure custom log patterns from the console, a Low
severity pattern translates to a 750,000
rank. A Medium
severity pattern translates to a 500,000
rank. And a High
severity pattern translates to a 250,000
rank. Rank values less than 1
or greater than 1,000,000
are reserved for Amazon Web Services provided patterns.
Sourcepub fn get_rank(&self) -> &Option<i32>
pub fn get_rank(&self) -> &Option<i32>
Rank of the log pattern. Must be a value between 1
and 1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1
will be the first to get matched to a log line. A pattern of rank 1,000,000
will be last to get matched. When you configure custom log patterns from the console, a Low
severity pattern translates to a 750,000
rank. A Medium
severity pattern translates to a 500,000
rank. And a High
severity pattern translates to a 250,000
rank. Rank values less than 1
or greater than 1,000,000
are reserved for Amazon Web Services provided patterns.
Sourcepub fn build(self) -> LogPattern
pub fn build(self) -> LogPattern
Consumes the builder and constructs a LogPattern
.
Trait Implementations§
Source§impl Clone for LogPatternBuilder
impl Clone for LogPatternBuilder
Source§fn clone(&self) -> LogPatternBuilder
fn clone(&self) -> LogPatternBuilder
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 LogPatternBuilder
impl Debug for LogPatternBuilder
Source§impl Default for LogPatternBuilder
impl Default for LogPatternBuilder
Source§fn default() -> LogPatternBuilder
fn default() -> LogPatternBuilder
Source§impl PartialEq for LogPatternBuilder
impl PartialEq for LogPatternBuilder
impl StructuralPartialEq for LogPatternBuilder
Auto Trait Implementations§
impl Freeze for LogPatternBuilder
impl RefUnwindSafe for LogPatternBuilder
impl Send for LogPatternBuilder
impl Sync for LogPatternBuilder
impl Unpin for LogPatternBuilder
impl UnwindSafe for LogPatternBuilder
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);