#[non_exhaustive]pub struct ApplyGuardrailOutput {
pub usage: Option<GuardrailUsage>,
pub action: GuardrailAction,
pub action_reason: Option<String>,
pub outputs: Vec<GuardrailOutputContent>,
pub assessments: Vec<GuardrailAssessment>,
pub guardrail_coverage: Option<GuardrailCoverage>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.usage: Option<GuardrailUsage>
The usage details in the response from the guardrail.
action: GuardrailAction
The action taken in the response from the guardrail.
action_reason: Option<String>
The reason for the action taken when harmful content is detected.
outputs: Vec<GuardrailOutputContent>
The output details in the response from the guardrail.
assessments: Vec<GuardrailAssessment>
The assessment details in the response from the guardrail.
guardrail_coverage: Option<GuardrailCoverage>
The guardrail coverage details in the apply guardrail response.
Implementations§
Source§impl ApplyGuardrailOutput
impl ApplyGuardrailOutput
Sourcepub fn usage(&self) -> Option<&GuardrailUsage>
pub fn usage(&self) -> Option<&GuardrailUsage>
The usage details in the response from the guardrail.
Sourcepub fn action(&self) -> &GuardrailAction
pub fn action(&self) -> &GuardrailAction
The action taken in the response from the guardrail.
Sourcepub fn action_reason(&self) -> Option<&str>
pub fn action_reason(&self) -> Option<&str>
The reason for the action taken when harmful content is detected.
Sourcepub fn outputs(&self) -> &[GuardrailOutputContent]
pub fn outputs(&self) -> &[GuardrailOutputContent]
The output details in the response from the guardrail.
Sourcepub fn assessments(&self) -> &[GuardrailAssessment]
pub fn assessments(&self) -> &[GuardrailAssessment]
The assessment details in the response from the guardrail.
Sourcepub fn guardrail_coverage(&self) -> Option<&GuardrailCoverage>
pub fn guardrail_coverage(&self) -> Option<&GuardrailCoverage>
The guardrail coverage details in the apply guardrail response.
Source§impl ApplyGuardrailOutput
impl ApplyGuardrailOutput
Sourcepub fn builder() -> ApplyGuardrailOutputBuilder
pub fn builder() -> ApplyGuardrailOutputBuilder
Creates a new builder-style object to manufacture ApplyGuardrailOutput
.
Trait Implementations§
Source§impl Clone for ApplyGuardrailOutput
impl Clone for ApplyGuardrailOutput
Source§fn clone(&self) -> ApplyGuardrailOutput
fn clone(&self) -> ApplyGuardrailOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ApplyGuardrailOutput
impl Debug for ApplyGuardrailOutput
Source§impl PartialEq for ApplyGuardrailOutput
impl PartialEq for ApplyGuardrailOutput
Source§impl RequestId for ApplyGuardrailOutput
impl RequestId for ApplyGuardrailOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for ApplyGuardrailOutput
Auto Trait Implementations§
impl Freeze for ApplyGuardrailOutput
impl RefUnwindSafe for ApplyGuardrailOutput
impl Send for ApplyGuardrailOutput
impl Sync for ApplyGuardrailOutput
impl Unpin for ApplyGuardrailOutput
impl UnwindSafe for ApplyGuardrailOutput
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);