#[non_exhaustive]pub struct ApplyGuardrailOutputBuilder { /* private fields */ }Expand description
A builder for ApplyGuardrailOutput.
Implementations§
Source§impl ApplyGuardrailOutputBuilder
impl ApplyGuardrailOutputBuilder
Sourcepub fn usage(self, input: GuardrailUsage) -> Self
pub fn usage(self, input: GuardrailUsage) -> Self
The usage details in the response from the guardrail.
This field is required.Sourcepub fn set_usage(self, input: Option<GuardrailUsage>) -> Self
pub fn set_usage(self, input: Option<GuardrailUsage>) -> Self
The usage details in the response from the guardrail.
Sourcepub fn get_usage(&self) -> &Option<GuardrailUsage>
pub fn get_usage(&self) -> &Option<GuardrailUsage>
The usage details in the response from the guardrail.
Sourcepub fn action(self, input: GuardrailAction) -> Self
pub fn action(self, input: GuardrailAction) -> Self
The action taken in the response from the guardrail.
This field is required.Sourcepub fn set_action(self, input: Option<GuardrailAction>) -> Self
pub fn set_action(self, input: Option<GuardrailAction>) -> Self
The action taken in the response from the guardrail.
Sourcepub fn get_action(&self) -> &Option<GuardrailAction>
pub fn get_action(&self) -> &Option<GuardrailAction>
The action taken in the response from the guardrail.
Sourcepub fn action_reason(self, input: impl Into<String>) -> Self
pub fn action_reason(self, input: impl Into<String>) -> Self
The reason for the action taken when harmful content is detected.
Sourcepub fn set_action_reason(self, input: Option<String>) -> Self
pub fn set_action_reason(self, input: Option<String>) -> Self
The reason for the action taken when harmful content is detected.
Sourcepub fn get_action_reason(&self) -> &Option<String>
pub fn get_action_reason(&self) -> &Option<String>
The reason for the action taken when harmful content is detected.
Sourcepub fn outputs(self, input: GuardrailOutputContent) -> Self
pub fn outputs(self, input: GuardrailOutputContent) -> Self
Appends an item to outputs.
To override the contents of this collection use set_outputs.
The output details in the response from the guardrail.
Sourcepub fn set_outputs(self, input: Option<Vec<GuardrailOutputContent>>) -> Self
pub fn set_outputs(self, input: Option<Vec<GuardrailOutputContent>>) -> Self
The output details in the response from the guardrail.
Sourcepub fn get_outputs(&self) -> &Option<Vec<GuardrailOutputContent>>
pub fn get_outputs(&self) -> &Option<Vec<GuardrailOutputContent>>
The output details in the response from the guardrail.
Sourcepub fn assessments(self, input: GuardrailAssessment) -> Self
pub fn assessments(self, input: GuardrailAssessment) -> Self
Appends an item to assessments.
To override the contents of this collection use set_assessments.
The assessment details in the response from the guardrail.
Sourcepub fn set_assessments(self, input: Option<Vec<GuardrailAssessment>>) -> Self
pub fn set_assessments(self, input: Option<Vec<GuardrailAssessment>>) -> Self
The assessment details in the response from the guardrail.
Sourcepub fn get_assessments(&self) -> &Option<Vec<GuardrailAssessment>>
pub fn get_assessments(&self) -> &Option<Vec<GuardrailAssessment>>
The assessment details in the response from the guardrail.
Sourcepub fn guardrail_coverage(self, input: GuardrailCoverage) -> Self
pub fn guardrail_coverage(self, input: GuardrailCoverage) -> Self
The guardrail coverage details in the apply guardrail response.
Sourcepub fn set_guardrail_coverage(self, input: Option<GuardrailCoverage>) -> Self
pub fn set_guardrail_coverage(self, input: Option<GuardrailCoverage>) -> Self
The guardrail coverage details in the apply guardrail response.
Sourcepub fn get_guardrail_coverage(&self) -> &Option<GuardrailCoverage>
pub fn get_guardrail_coverage(&self) -> &Option<GuardrailCoverage>
The guardrail coverage details in the apply guardrail response.
Sourcepub fn build(self) -> Result<ApplyGuardrailOutput, BuildError>
pub fn build(self) -> Result<ApplyGuardrailOutput, BuildError>
Consumes the builder and constructs a ApplyGuardrailOutput.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ApplyGuardrailOutputBuilder
impl Clone for ApplyGuardrailOutputBuilder
Source§fn clone(&self) -> ApplyGuardrailOutputBuilder
fn clone(&self) -> ApplyGuardrailOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ApplyGuardrailOutputBuilder
impl Debug for ApplyGuardrailOutputBuilder
Source§impl Default for ApplyGuardrailOutputBuilder
impl Default for ApplyGuardrailOutputBuilder
Source§fn default() -> ApplyGuardrailOutputBuilder
fn default() -> ApplyGuardrailOutputBuilder
impl StructuralPartialEq for ApplyGuardrailOutputBuilder
Auto Trait Implementations§
impl Freeze for ApplyGuardrailOutputBuilder
impl RefUnwindSafe for ApplyGuardrailOutputBuilder
impl Send for ApplyGuardrailOutputBuilder
impl Sync for ApplyGuardrailOutputBuilder
impl Unpin for ApplyGuardrailOutputBuilder
impl UnwindSafe for ApplyGuardrailOutputBuilder
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);