#[non_exhaustive]pub struct ValidatePolicyFindingBuilder { /* private fields */ }Expand description
A builder for ValidatePolicyFinding.
Implementations§
Source§impl ValidatePolicyFindingBuilder
impl ValidatePolicyFindingBuilder
Sourcepub fn finding_details(self, input: impl Into<String>) -> Self
pub fn finding_details(self, input: impl Into<String>) -> Self
A localized message that explains the finding and provides guidance on how to address it.
This field is required.Sourcepub fn set_finding_details(self, input: Option<String>) -> Self
pub fn set_finding_details(self, input: Option<String>) -> Self
A localized message that explains the finding and provides guidance on how to address it.
Sourcepub fn get_finding_details(&self) -> &Option<String>
pub fn get_finding_details(&self) -> &Option<String>
A localized message that explains the finding and provides guidance on how to address it.
Sourcepub fn finding_type(self, input: ValidatePolicyFindingType) -> Self
pub fn finding_type(self, input: ValidatePolicyFindingType) -> Self
The impact of the finding.
Security warnings report when the policy allows access that we consider overly permissive.
Errors report when a part of the policy is not functional.
Warnings report non-security issues when a policy does not conform to policy writing best practices.
Suggestions recommend stylistic improvements in the policy that do not impact access.
This field is required.Sourcepub fn set_finding_type(self, input: Option<ValidatePolicyFindingType>) -> Self
pub fn set_finding_type(self, input: Option<ValidatePolicyFindingType>) -> Self
The impact of the finding.
Security warnings report when the policy allows access that we consider overly permissive.
Errors report when a part of the policy is not functional.
Warnings report non-security issues when a policy does not conform to policy writing best practices.
Suggestions recommend stylistic improvements in the policy that do not impact access.
Sourcepub fn get_finding_type(&self) -> &Option<ValidatePolicyFindingType>
pub fn get_finding_type(&self) -> &Option<ValidatePolicyFindingType>
The impact of the finding.
Security warnings report when the policy allows access that we consider overly permissive.
Errors report when a part of the policy is not functional.
Warnings report non-security issues when a policy does not conform to policy writing best practices.
Suggestions recommend stylistic improvements in the policy that do not impact access.
Sourcepub fn issue_code(self, input: impl Into<String>) -> Self
pub fn issue_code(self, input: impl Into<String>) -> Self
The issue code provides an identifier of the issue associated with this finding.
This field is required.Sourcepub fn set_issue_code(self, input: Option<String>) -> Self
pub fn set_issue_code(self, input: Option<String>) -> Self
The issue code provides an identifier of the issue associated with this finding.
Sourcepub fn get_issue_code(&self) -> &Option<String>
pub fn get_issue_code(&self) -> &Option<String>
The issue code provides an identifier of the issue associated with this finding.
Sourcepub fn learn_more_link(self, input: impl Into<String>) -> Self
pub fn learn_more_link(self, input: impl Into<String>) -> Self
A link to additional documentation about the type of finding.
This field is required.Sourcepub fn set_learn_more_link(self, input: Option<String>) -> Self
pub fn set_learn_more_link(self, input: Option<String>) -> Self
A link to additional documentation about the type of finding.
Sourcepub fn get_learn_more_link(&self) -> &Option<String>
pub fn get_learn_more_link(&self) -> &Option<String>
A link to additional documentation about the type of finding.
Sourcepub fn locations(self, input: Location) -> Self
pub fn locations(self, input: Location) -> Self
Appends an item to locations.
To override the contents of this collection use set_locations.
The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.
Sourcepub fn set_locations(self, input: Option<Vec<Location>>) -> Self
pub fn set_locations(self, input: Option<Vec<Location>>) -> Self
The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.
Sourcepub fn get_locations(&self) -> &Option<Vec<Location>>
pub fn get_locations(&self) -> &Option<Vec<Location>>
The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.
Sourcepub fn build(self) -> Result<ValidatePolicyFinding, BuildError>
pub fn build(self) -> Result<ValidatePolicyFinding, BuildError>
Consumes the builder and constructs a ValidatePolicyFinding.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ValidatePolicyFindingBuilder
impl Clone for ValidatePolicyFindingBuilder
Source§fn clone(&self) -> ValidatePolicyFindingBuilder
fn clone(&self) -> ValidatePolicyFindingBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ValidatePolicyFindingBuilder
impl Debug for ValidatePolicyFindingBuilder
Source§impl Default for ValidatePolicyFindingBuilder
impl Default for ValidatePolicyFindingBuilder
Source§fn default() -> ValidatePolicyFindingBuilder
fn default() -> ValidatePolicyFindingBuilder
Source§impl PartialEq for ValidatePolicyFindingBuilder
impl PartialEq for ValidatePolicyFindingBuilder
Source§fn eq(&self, other: &ValidatePolicyFindingBuilder) -> bool
fn eq(&self, other: &ValidatePolicyFindingBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for ValidatePolicyFindingBuilder
Auto Trait Implementations§
impl Freeze for ValidatePolicyFindingBuilder
impl RefUnwindSafe for ValidatePolicyFindingBuilder
impl Send for ValidatePolicyFindingBuilder
impl Sync for ValidatePolicyFindingBuilder
impl Unpin for ValidatePolicyFindingBuilder
impl UnwindSafe for ValidatePolicyFindingBuilder
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);