#[non_exhaustive]pub struct GuardrailUsageBuilder { /* private fields */ }
Expand description
A builder for GuardrailUsage
.
Implementations§
Source§impl GuardrailUsageBuilder
impl GuardrailUsageBuilder
Sourcepub fn topic_policy_units(self, input: i32) -> Self
pub fn topic_policy_units(self, input: i32) -> Self
The topic policy units processed by the guardrail.
This field is required.Sourcepub fn set_topic_policy_units(self, input: Option<i32>) -> Self
pub fn set_topic_policy_units(self, input: Option<i32>) -> Self
The topic policy units processed by the guardrail.
Sourcepub fn get_topic_policy_units(&self) -> &Option<i32>
pub fn get_topic_policy_units(&self) -> &Option<i32>
The topic policy units processed by the guardrail.
Sourcepub fn content_policy_units(self, input: i32) -> Self
pub fn content_policy_units(self, input: i32) -> Self
The content policy units processed by the guardrail.
This field is required.Sourcepub fn set_content_policy_units(self, input: Option<i32>) -> Self
pub fn set_content_policy_units(self, input: Option<i32>) -> Self
The content policy units processed by the guardrail.
Sourcepub fn get_content_policy_units(&self) -> &Option<i32>
pub fn get_content_policy_units(&self) -> &Option<i32>
The content policy units processed by the guardrail.
Sourcepub fn word_policy_units(self, input: i32) -> Self
pub fn word_policy_units(self, input: i32) -> Self
The word policy units processed by the guardrail.
This field is required.Sourcepub fn set_word_policy_units(self, input: Option<i32>) -> Self
pub fn set_word_policy_units(self, input: Option<i32>) -> Self
The word policy units processed by the guardrail.
Sourcepub fn get_word_policy_units(&self) -> &Option<i32>
pub fn get_word_policy_units(&self) -> &Option<i32>
The word policy units processed by the guardrail.
Sourcepub fn sensitive_information_policy_units(self, input: i32) -> Self
pub fn sensitive_information_policy_units(self, input: i32) -> Self
The sensitive information policy units processed by the guardrail.
This field is required.Sourcepub fn set_sensitive_information_policy_units(self, input: Option<i32>) -> Self
pub fn set_sensitive_information_policy_units(self, input: Option<i32>) -> Self
The sensitive information policy units processed by the guardrail.
Sourcepub fn get_sensitive_information_policy_units(&self) -> &Option<i32>
pub fn get_sensitive_information_policy_units(&self) -> &Option<i32>
The sensitive information policy units processed by the guardrail.
Sourcepub fn sensitive_information_policy_free_units(self, input: i32) -> Self
pub fn sensitive_information_policy_free_units(self, input: i32) -> Self
The sensitive information policy free units processed by the guardrail.
This field is required.Sourcepub fn set_sensitive_information_policy_free_units(
self,
input: Option<i32>,
) -> Self
pub fn set_sensitive_information_policy_free_units( self, input: Option<i32>, ) -> Self
The sensitive information policy free units processed by the guardrail.
Sourcepub fn get_sensitive_information_policy_free_units(&self) -> &Option<i32>
pub fn get_sensitive_information_policy_free_units(&self) -> &Option<i32>
The sensitive information policy free units processed by the guardrail.
Sourcepub fn contextual_grounding_policy_units(self, input: i32) -> Self
pub fn contextual_grounding_policy_units(self, input: i32) -> Self
The contextual grounding policy units processed by the guardrail.
This field is required.Sourcepub fn set_contextual_grounding_policy_units(self, input: Option<i32>) -> Self
pub fn set_contextual_grounding_policy_units(self, input: Option<i32>) -> Self
The contextual grounding policy units processed by the guardrail.
Sourcepub fn get_contextual_grounding_policy_units(&self) -> &Option<i32>
pub fn get_contextual_grounding_policy_units(&self) -> &Option<i32>
The contextual grounding policy units processed by the guardrail.
Sourcepub fn content_policy_image_units(self, input: i32) -> Self
pub fn content_policy_image_units(self, input: i32) -> Self
The content policy image units processed by the guardrail.
Sourcepub fn set_content_policy_image_units(self, input: Option<i32>) -> Self
pub fn set_content_policy_image_units(self, input: Option<i32>) -> Self
The content policy image units processed by the guardrail.
Sourcepub fn get_content_policy_image_units(&self) -> &Option<i32>
pub fn get_content_policy_image_units(&self) -> &Option<i32>
The content policy image units processed by the guardrail.
Sourcepub fn automated_reasoning_policy_units(self, input: i32) -> Self
pub fn automated_reasoning_policy_units(self, input: i32) -> Self
The number of text units processed by the automated reasoning policy.
Sourcepub fn set_automated_reasoning_policy_units(self, input: Option<i32>) -> Self
pub fn set_automated_reasoning_policy_units(self, input: Option<i32>) -> Self
The number of text units processed by the automated reasoning policy.
Sourcepub fn get_automated_reasoning_policy_units(&self) -> &Option<i32>
pub fn get_automated_reasoning_policy_units(&self) -> &Option<i32>
The number of text units processed by the automated reasoning policy.
Sourcepub fn automated_reasoning_policies(self, input: i32) -> Self
pub fn automated_reasoning_policies(self, input: i32) -> Self
The number of automated reasoning policies that were processed during the guardrail evaluation.
Sourcepub fn set_automated_reasoning_policies(self, input: Option<i32>) -> Self
pub fn set_automated_reasoning_policies(self, input: Option<i32>) -> Self
The number of automated reasoning policies that were processed during the guardrail evaluation.
Sourcepub fn get_automated_reasoning_policies(&self) -> &Option<i32>
pub fn get_automated_reasoning_policies(&self) -> &Option<i32>
The number of automated reasoning policies that were processed during the guardrail evaluation.
Sourcepub fn build(self) -> Result<GuardrailUsage, BuildError>
pub fn build(self) -> Result<GuardrailUsage, BuildError>
Consumes the builder and constructs a GuardrailUsage
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for GuardrailUsageBuilder
impl Clone for GuardrailUsageBuilder
Source§fn clone(&self) -> GuardrailUsageBuilder
fn clone(&self) -> GuardrailUsageBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GuardrailUsageBuilder
impl Debug for GuardrailUsageBuilder
Source§impl Default for GuardrailUsageBuilder
impl Default for GuardrailUsageBuilder
Source§fn default() -> GuardrailUsageBuilder
fn default() -> GuardrailUsageBuilder
Source§impl PartialEq for GuardrailUsageBuilder
impl PartialEq for GuardrailUsageBuilder
impl StructuralPartialEq for GuardrailUsageBuilder
Auto Trait Implementations§
impl Freeze for GuardrailUsageBuilder
impl RefUnwindSafe for GuardrailUsageBuilder
impl Send for GuardrailUsageBuilder
impl Sync for GuardrailUsageBuilder
impl Unpin for GuardrailUsageBuilder
impl UnwindSafe for GuardrailUsageBuilder
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);