#[non_exhaustive]pub struct RegexMatchTupleBuilder { /* private fields */ }
Expand description
A builder for RegexMatchTuple
.
Implementations§
Source§impl RegexMatchTupleBuilder
impl RegexMatchTupleBuilder
Sourcepub fn field_to_match(self, input: FieldToMatch) -> Self
pub fn field_to_match(self, input: FieldToMatch) -> Self
Specifies where in a web request to look for the RegexPatternSet
.
Sourcepub fn set_field_to_match(self, input: Option<FieldToMatch>) -> Self
pub fn set_field_to_match(self, input: Option<FieldToMatch>) -> Self
Specifies where in a web request to look for the RegexPatternSet
.
Sourcepub fn get_field_to_match(&self) -> &Option<FieldToMatch>
pub fn get_field_to_match(&self) -> &Option<FieldToMatch>
Specifies where in a web request to look for the RegexPatternSet
.
Sourcepub fn text_transformation(self, input: TextTransformation) -> Self
pub fn text_transformation(self, input: TextTransformation) -> Self
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet
before inspecting a request for a match.
You can only specify a single type of TextTransformation.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
-
Delete the following characters: \ " ' ^
-
Delete spaces before the following characters: / (
-
Replace the following characters with a space: , ;
-
Replace multiple spaces with one space
-
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
-
\f, formfeed, decimal 12
-
\t, tab, decimal 9
-
\n, newline, decimal 10
-
\r, carriage return, decimal 13
-
\v, vertical tab, decimal 11
-
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
-
Replaces
(ampersand)quot;
with"
-
Replaces
(ampersand)nbsp;
with a non-breaking space, decimal 160 -
Replaces
(ampersand)lt;
with a "less than" symbol -
Replaces
(ampersand)gt;
with>
-
Replaces characters that are represented in hexadecimal format,
(ampersand)#xhhhh;
, with the corresponding characters -
Replaces characters that are represented in decimal format,
(ampersand)#nnnn;
, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE
if you don't want to perform any text transformations.
Sourcepub fn set_text_transformation(self, input: Option<TextTransformation>) -> Self
pub fn set_text_transformation(self, input: Option<TextTransformation>) -> Self
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet
before inspecting a request for a match.
You can only specify a single type of TextTransformation.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
-
Delete the following characters: \ " ' ^
-
Delete spaces before the following characters: / (
-
Replace the following characters with a space: , ;
-
Replace multiple spaces with one space
-
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
-
\f, formfeed, decimal 12
-
\t, tab, decimal 9
-
\n, newline, decimal 10
-
\r, carriage return, decimal 13
-
\v, vertical tab, decimal 11
-
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
-
Replaces
(ampersand)quot;
with"
-
Replaces
(ampersand)nbsp;
with a non-breaking space, decimal 160 -
Replaces
(ampersand)lt;
with a "less than" symbol -
Replaces
(ampersand)gt;
with>
-
Replaces characters that are represented in hexadecimal format,
(ampersand)#xhhhh;
, with the corresponding characters -
Replaces characters that are represented in decimal format,
(ampersand)#nnnn;
, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE
if you don't want to perform any text transformations.
Sourcepub fn get_text_transformation(&self) -> &Option<TextTransformation>
pub fn get_text_transformation(&self) -> &Option<TextTransformation>
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet
before inspecting a request for a match.
You can only specify a single type of TextTransformation.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
-
Delete the following characters: \ " ' ^
-
Delete spaces before the following characters: / (
-
Replace the following characters with a space: , ;
-
Replace multiple spaces with one space
-
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
-
\f, formfeed, decimal 12
-
\t, tab, decimal 9
-
\n, newline, decimal 10
-
\r, carriage return, decimal 13
-
\v, vertical tab, decimal 11
-
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
-
Replaces
(ampersand)quot;
with"
-
Replaces
(ampersand)nbsp;
with a non-breaking space, decimal 160 -
Replaces
(ampersand)lt;
with a "less than" symbol -
Replaces
(ampersand)gt;
with>
-
Replaces characters that are represented in hexadecimal format,
(ampersand)#xhhhh;
, with the corresponding characters -
Replaces characters that are represented in decimal format,
(ampersand)#nnnn;
, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE
if you don't want to perform any text transformations.
Sourcepub fn regex_pattern_set_id(self, input: impl Into<String>) -> Self
pub fn regex_pattern_set_id(self, input: impl Into<String>) -> Self
The RegexPatternSetId
for a RegexPatternSet
. You use RegexPatternSetId
to get information about a RegexPatternSet
(see GetRegexPatternSet
), update a RegexPatternSet
(see UpdateRegexPatternSet
), insert a RegexPatternSet
into a RegexMatchSet
or delete one from a RegexMatchSet
(see UpdateRegexMatchSet
), and delete an RegexPatternSet
from AWS WAF (see DeleteRegexPatternSet
).
RegexPatternSetId
is returned by CreateRegexPatternSet
and by ListRegexPatternSets
.
Sourcepub fn set_regex_pattern_set_id(self, input: Option<String>) -> Self
pub fn set_regex_pattern_set_id(self, input: Option<String>) -> Self
The RegexPatternSetId
for a RegexPatternSet
. You use RegexPatternSetId
to get information about a RegexPatternSet
(see GetRegexPatternSet
), update a RegexPatternSet
(see UpdateRegexPatternSet
), insert a RegexPatternSet
into a RegexMatchSet
or delete one from a RegexMatchSet
(see UpdateRegexMatchSet
), and delete an RegexPatternSet
from AWS WAF (see DeleteRegexPatternSet
).
RegexPatternSetId
is returned by CreateRegexPatternSet
and by ListRegexPatternSets
.
Sourcepub fn get_regex_pattern_set_id(&self) -> &Option<String>
pub fn get_regex_pattern_set_id(&self) -> &Option<String>
The RegexPatternSetId
for a RegexPatternSet
. You use RegexPatternSetId
to get information about a RegexPatternSet
(see GetRegexPatternSet
), update a RegexPatternSet
(see UpdateRegexPatternSet
), insert a RegexPatternSet
into a RegexMatchSet
or delete one from a RegexMatchSet
(see UpdateRegexMatchSet
), and delete an RegexPatternSet
from AWS WAF (see DeleteRegexPatternSet
).
RegexPatternSetId
is returned by CreateRegexPatternSet
and by ListRegexPatternSets
.
Sourcepub fn build(self) -> Result<RegexMatchTuple, BuildError>
pub fn build(self) -> Result<RegexMatchTuple, BuildError>
Consumes the builder and constructs a RegexMatchTuple
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for RegexMatchTupleBuilder
impl Clone for RegexMatchTupleBuilder
Source§fn clone(&self) -> RegexMatchTupleBuilder
fn clone(&self) -> RegexMatchTupleBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RegexMatchTupleBuilder
impl Debug for RegexMatchTupleBuilder
Source§impl Default for RegexMatchTupleBuilder
impl Default for RegexMatchTupleBuilder
Source§fn default() -> RegexMatchTupleBuilder
fn default() -> RegexMatchTupleBuilder
Source§impl PartialEq for RegexMatchTupleBuilder
impl PartialEq for RegexMatchTupleBuilder
impl StructuralPartialEq for RegexMatchTupleBuilder
Auto Trait Implementations§
impl Freeze for RegexMatchTupleBuilder
impl RefUnwindSafe for RegexMatchTupleBuilder
impl Send for RegexMatchTupleBuilder
impl Sync for RegexMatchTupleBuilder
impl Unpin for RegexMatchTupleBuilder
impl UnwindSafe for RegexMatchTupleBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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);