#[non_exhaustive]pub struct PatternTokenBuilder { /* private fields */ }
Expand description
A builder for PatternToken
.
Implementations§
Source§impl PatternTokenBuilder
impl PatternTokenBuilder
Sourcepub fn dynamic_token_position(self, input: i32) -> Self
pub fn dynamic_token_position(self, input: i32) -> Self
For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of 1
, the one that appears second is 2
, and so on.
Sourcepub fn set_dynamic_token_position(self, input: Option<i32>) -> Self
pub fn set_dynamic_token_position(self, input: Option<i32>) -> Self
For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of 1
, the one that appears second is 2
, and so on.
Sourcepub fn get_dynamic_token_position(&self) -> &Option<i32>
pub fn get_dynamic_token_position(&self) -> &Option<i32>
For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of 1
, the one that appears second is 2
, and so on.
Sourcepub fn is_dynamic(self, input: bool) -> Self
pub fn is_dynamic(self, input: bool) -> Self
Specifies whether this is a dynamic token.
Sourcepub fn set_is_dynamic(self, input: Option<bool>) -> Self
pub fn set_is_dynamic(self, input: Option<bool>) -> Self
Specifies whether this is a dynamic token.
Sourcepub fn get_is_dynamic(&self) -> &Option<bool>
pub fn get_is_dynamic(&self) -> &Option<bool>
Specifies whether this is a dynamic token.
Sourcepub fn token_string(self, input: impl Into<String>) -> Self
pub fn token_string(self, input: impl Into<String>) -> Self
The string represented by this token. If this is a dynamic token, the value will be <*>
Sourcepub fn set_token_string(self, input: Option<String>) -> Self
pub fn set_token_string(self, input: Option<String>) -> Self
The string represented by this token. If this is a dynamic token, the value will be <*>
Sourcepub fn get_token_string(&self) -> &Option<String>
pub fn get_token_string(&self) -> &Option<String>
The string represented by this token. If this is a dynamic token, the value will be <*>
Sourcepub fn enumerations(self, k: impl Into<String>, v: i64) -> Self
pub fn enumerations(self, k: impl Into<String>, v: i64) -> Self
Adds a key-value pair to enumerations
.
To override the contents of this collection use set_enumerations
.
Contains the values found for a dynamic token, and the number of times each value was found.
Sourcepub fn set_enumerations(self, input: Option<HashMap<String, i64>>) -> Self
pub fn set_enumerations(self, input: Option<HashMap<String, i64>>) -> Self
Contains the values found for a dynamic token, and the number of times each value was found.
Sourcepub fn get_enumerations(&self) -> &Option<HashMap<String, i64>>
pub fn get_enumerations(&self) -> &Option<HashMap<String, i64>>
Contains the values found for a dynamic token, and the number of times each value was found.
Sourcepub fn inferred_token_name(self, input: impl Into<String>) -> Self
pub fn inferred_token_name(self, input: impl Into<String>) -> Self
A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of the inferredTokenName
gives you a clearer idea of the content of this token. The number part of the inferredTokenName
shows where in the pattern this token appears, compared to other dynamic tokens. CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.
For example, an inferred token name of IPAddress-3
means that the token represents an IP address, and this token is the third dynamic token in the pattern.
Sourcepub fn set_inferred_token_name(self, input: Option<String>) -> Self
pub fn set_inferred_token_name(self, input: Option<String>) -> Self
A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of the inferredTokenName
gives you a clearer idea of the content of this token. The number part of the inferredTokenName
shows where in the pattern this token appears, compared to other dynamic tokens. CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.
For example, an inferred token name of IPAddress-3
means that the token represents an IP address, and this token is the third dynamic token in the pattern.
Sourcepub fn get_inferred_token_name(&self) -> &Option<String>
pub fn get_inferred_token_name(&self) -> &Option<String>
A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of the inferredTokenName
gives you a clearer idea of the content of this token. The number part of the inferredTokenName
shows where in the pattern this token appears, compared to other dynamic tokens. CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.
For example, an inferred token name of IPAddress-3
means that the token represents an IP address, and this token is the third dynamic token in the pattern.
Sourcepub fn build(self) -> PatternToken
pub fn build(self) -> PatternToken
Consumes the builder and constructs a PatternToken
.
Trait Implementations§
Source§impl Clone for PatternTokenBuilder
impl Clone for PatternTokenBuilder
Source§fn clone(&self) -> PatternTokenBuilder
fn clone(&self) -> PatternTokenBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PatternTokenBuilder
impl Debug for PatternTokenBuilder
Source§impl Default for PatternTokenBuilder
impl Default for PatternTokenBuilder
Source§fn default() -> PatternTokenBuilder
fn default() -> PatternTokenBuilder
Source§impl PartialEq for PatternTokenBuilder
impl PartialEq for PatternTokenBuilder
impl StructuralPartialEq for PatternTokenBuilder
Auto Trait Implementations§
impl Freeze for PatternTokenBuilder
impl RefUnwindSafe for PatternTokenBuilder
impl Send for PatternTokenBuilder
impl Sync for PatternTokenBuilder
impl Unpin for PatternTokenBuilder
impl UnwindSafe for PatternTokenBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);