#[non_exhaustive]pub struct RuleConditionBuilder { /* private fields */ }
Expand description
A builder for RuleCondition
.
Implementations§
Source§impl RuleConditionBuilder
impl RuleConditionBuilder
Sourcepub fn field(self, input: impl Into<String>) -> Self
pub fn field(self, input: impl Into<String>) -> Self
The field in the HTTP request. The following are the possible values:
-
http-header
-
http-request-method
-
host-header
-
path-pattern
-
query-string
-
source-ip
Sourcepub fn set_field(self, input: Option<String>) -> Self
pub fn set_field(self, input: Option<String>) -> Self
The field in the HTTP request. The following are the possible values:
-
http-header
-
http-request-method
-
host-header
-
path-pattern
-
query-string
-
source-ip
Sourcepub fn get_field(&self) -> &Option<String>
pub fn get_field(&self) -> &Option<String>
The field in the HTTP request. The following are the possible values:
-
http-header
-
http-request-method
-
host-header
-
path-pattern
-
query-string
-
source-ip
Sourcepub fn values(self, input: impl Into<String>) -> Self
pub fn values(self, input: impl Into<String>) -> Self
Appends an item to values
.
To override the contents of this collection use set_values
.
The condition value. Specify only when Field
is host-header
or path-pattern
. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig
or PathPatternConfig
.
If Field
is host-header
and you are not using HostHeaderConfig
, you can specify a single host name (for example, my.example.com) in Values
. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
-
A-Z, a-z, 0-9
-
- .
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
If Field
is path-pattern
and you are not using PathPatternConfig
, you can specify a single path pattern (for example, /img/*) in Values
. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
-
A-Z, a-z, 0-9
-
_ - . $ / ~ " ' @ : +
-
& (using &)
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
Sourcepub fn set_values(self, input: Option<Vec<String>>) -> Self
pub fn set_values(self, input: Option<Vec<String>>) -> Self
The condition value. Specify only when Field
is host-header
or path-pattern
. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig
or PathPatternConfig
.
If Field
is host-header
and you are not using HostHeaderConfig
, you can specify a single host name (for example, my.example.com) in Values
. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
-
A-Z, a-z, 0-9
-
- .
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
If Field
is path-pattern
and you are not using PathPatternConfig
, you can specify a single path pattern (for example, /img/*) in Values
. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
-
A-Z, a-z, 0-9
-
_ - . $ / ~ " ' @ : +
-
& (using &)
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
Sourcepub fn get_values(&self) -> &Option<Vec<String>>
pub fn get_values(&self) -> &Option<Vec<String>>
The condition value. Specify only when Field
is host-header
or path-pattern
. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig
or PathPatternConfig
.
If Field
is host-header
and you are not using HostHeaderConfig
, you can specify a single host name (for example, my.example.com) in Values
. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
-
A-Z, a-z, 0-9
-
- .
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
If Field
is path-pattern
and you are not using PathPatternConfig
, you can specify a single path pattern (for example, /img/*) in Values
. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
-
A-Z, a-z, 0-9
-
_ - . $ / ~ " ' @ : +
-
& (using &)
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
Sourcepub fn host_header_config(self, input: HostHeaderConditionConfig) -> Self
pub fn host_header_config(self, input: HostHeaderConditionConfig) -> Self
Information for a host header condition. Specify only when Field
is host-header
.
Sourcepub fn set_host_header_config(
self,
input: Option<HostHeaderConditionConfig>,
) -> Self
pub fn set_host_header_config( self, input: Option<HostHeaderConditionConfig>, ) -> Self
Information for a host header condition. Specify only when Field
is host-header
.
Sourcepub fn get_host_header_config(&self) -> &Option<HostHeaderConditionConfig>
pub fn get_host_header_config(&self) -> &Option<HostHeaderConditionConfig>
Information for a host header condition. Specify only when Field
is host-header
.
Sourcepub fn path_pattern_config(self, input: PathPatternConditionConfig) -> Self
pub fn path_pattern_config(self, input: PathPatternConditionConfig) -> Self
Information for a path pattern condition. Specify only when Field
is path-pattern
.
Sourcepub fn set_path_pattern_config(
self,
input: Option<PathPatternConditionConfig>,
) -> Self
pub fn set_path_pattern_config( self, input: Option<PathPatternConditionConfig>, ) -> Self
Information for a path pattern condition. Specify only when Field
is path-pattern
.
Sourcepub fn get_path_pattern_config(&self) -> &Option<PathPatternConditionConfig>
pub fn get_path_pattern_config(&self) -> &Option<PathPatternConditionConfig>
Information for a path pattern condition. Specify only when Field
is path-pattern
.
Sourcepub fn http_header_config(self, input: HttpHeaderConditionConfig) -> Self
pub fn http_header_config(self, input: HttpHeaderConditionConfig) -> Self
Information for an HTTP header condition. Specify only when Field
is http-header
.
Sourcepub fn set_http_header_config(
self,
input: Option<HttpHeaderConditionConfig>,
) -> Self
pub fn set_http_header_config( self, input: Option<HttpHeaderConditionConfig>, ) -> Self
Information for an HTTP header condition. Specify only when Field
is http-header
.
Sourcepub fn get_http_header_config(&self) -> &Option<HttpHeaderConditionConfig>
pub fn get_http_header_config(&self) -> &Option<HttpHeaderConditionConfig>
Information for an HTTP header condition. Specify only when Field
is http-header
.
Sourcepub fn query_string_config(self, input: QueryStringConditionConfig) -> Self
pub fn query_string_config(self, input: QueryStringConditionConfig) -> Self
Information for a query string condition. Specify only when Field
is query-string
.
Sourcepub fn set_query_string_config(
self,
input: Option<QueryStringConditionConfig>,
) -> Self
pub fn set_query_string_config( self, input: Option<QueryStringConditionConfig>, ) -> Self
Information for a query string condition. Specify only when Field
is query-string
.
Sourcepub fn get_query_string_config(&self) -> &Option<QueryStringConditionConfig>
pub fn get_query_string_config(&self) -> &Option<QueryStringConditionConfig>
Information for a query string condition. Specify only when Field
is query-string
.
Sourcepub fn http_request_method_config(
self,
input: HttpRequestMethodConditionConfig,
) -> Self
pub fn http_request_method_config( self, input: HttpRequestMethodConditionConfig, ) -> Self
Information for an HTTP method condition. Specify only when Field
is http-request-method
.
Sourcepub fn set_http_request_method_config(
self,
input: Option<HttpRequestMethodConditionConfig>,
) -> Self
pub fn set_http_request_method_config( self, input: Option<HttpRequestMethodConditionConfig>, ) -> Self
Information for an HTTP method condition. Specify only when Field
is http-request-method
.
Sourcepub fn get_http_request_method_config(
&self,
) -> &Option<HttpRequestMethodConditionConfig>
pub fn get_http_request_method_config( &self, ) -> &Option<HttpRequestMethodConditionConfig>
Information for an HTTP method condition. Specify only when Field
is http-request-method
.
Sourcepub fn source_ip_config(self, input: SourceIpConditionConfig) -> Self
pub fn source_ip_config(self, input: SourceIpConditionConfig) -> Self
Information for a source IP condition. Specify only when Field
is source-ip
.
Sourcepub fn set_source_ip_config(
self,
input: Option<SourceIpConditionConfig>,
) -> Self
pub fn set_source_ip_config( self, input: Option<SourceIpConditionConfig>, ) -> Self
Information for a source IP condition. Specify only when Field
is source-ip
.
Sourcepub fn get_source_ip_config(&self) -> &Option<SourceIpConditionConfig>
pub fn get_source_ip_config(&self) -> &Option<SourceIpConditionConfig>
Information for a source IP condition. Specify only when Field
is source-ip
.
Sourcepub fn build(self) -> RuleCondition
pub fn build(self) -> RuleCondition
Consumes the builder and constructs a RuleCondition
.
Trait Implementations§
Source§impl Clone for RuleConditionBuilder
impl Clone for RuleConditionBuilder
Source§fn clone(&self) -> RuleConditionBuilder
fn clone(&self) -> RuleConditionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RuleConditionBuilder
impl Debug for RuleConditionBuilder
Source§impl Default for RuleConditionBuilder
impl Default for RuleConditionBuilder
Source§fn default() -> RuleConditionBuilder
fn default() -> RuleConditionBuilder
Source§impl PartialEq for RuleConditionBuilder
impl PartialEq for RuleConditionBuilder
impl StructuralPartialEq for RuleConditionBuilder
Auto Trait Implementations§
impl Freeze for RuleConditionBuilder
impl RefUnwindSafe for RuleConditionBuilder
impl Send for RuleConditionBuilder
impl Sync for RuleConditionBuilder
impl Unpin for RuleConditionBuilder
impl UnwindSafe for RuleConditionBuilder
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);