#[non_exhaustive]pub struct TracePartBuilder { /* private fields */ }
Expand description
A builder for TracePart
.
Implementations§
Source§impl TracePartBuilder
impl TracePartBuilder
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The unique identifier of the session with the agent.
Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The unique identifier of the session with the agent.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The unique identifier of the session with the agent.
Sourcepub fn trace(self, input: Trace) -> Self
pub fn trace(self, input: Trace) -> Self
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
Sourcepub fn set_trace(self, input: Option<Trace>) -> Self
pub fn set_trace(self, input: Option<Trace>) -> Self
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
Sourcepub fn get_trace(&self) -> &Option<Trace>
pub fn get_trace(&self) -> &Option<Trace>
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
Sourcepub fn caller_chain(self, input: Caller) -> Self
pub fn caller_chain(self, input: Caller) -> Self
Appends an item to caller_chain
.
To override the contents of this collection use set_caller_chain
.
The part's caller chain.
Sourcepub fn set_caller_chain(self, input: Option<Vec<Caller>>) -> Self
pub fn set_caller_chain(self, input: Option<Vec<Caller>>) -> Self
The part's caller chain.
Sourcepub fn get_caller_chain(&self) -> &Option<Vec<Caller>>
pub fn get_caller_chain(&self) -> &Option<Vec<Caller>>
The part's caller chain.
Sourcepub fn event_time(self, input: DateTime) -> Self
pub fn event_time(self, input: DateTime) -> Self
The time of the trace.
Sourcepub fn set_event_time(self, input: Option<DateTime>) -> Self
pub fn set_event_time(self, input: Option<DateTime>) -> Self
The time of the trace.
Sourcepub fn get_event_time(&self) -> &Option<DateTime>
pub fn get_event_time(&self) -> &Option<DateTime>
The time of the trace.
Sourcepub fn collaborator_name(self, input: impl Into<String>) -> Self
pub fn collaborator_name(self, input: impl Into<String>) -> Self
The part's collaborator name.
Sourcepub fn set_collaborator_name(self, input: Option<String>) -> Self
pub fn set_collaborator_name(self, input: Option<String>) -> Self
The part's collaborator name.
Sourcepub fn get_collaborator_name(&self) -> &Option<String>
pub fn get_collaborator_name(&self) -> &Option<String>
The part's collaborator name.
Sourcepub fn set_agent_id(self, input: Option<String>) -> Self
pub fn set_agent_id(self, input: Option<String>) -> Self
The unique identifier of the agent.
Sourcepub fn get_agent_id(&self) -> &Option<String>
pub fn get_agent_id(&self) -> &Option<String>
The unique identifier of the agent.
Sourcepub fn agent_alias_id(self, input: impl Into<String>) -> Self
pub fn agent_alias_id(self, input: impl Into<String>) -> Self
The unique identifier of the alias of the agent.
Sourcepub fn set_agent_alias_id(self, input: Option<String>) -> Self
pub fn set_agent_alias_id(self, input: Option<String>) -> Self
The unique identifier of the alias of the agent.
Sourcepub fn get_agent_alias_id(&self) -> &Option<String>
pub fn get_agent_alias_id(&self) -> &Option<String>
The unique identifier of the alias of the agent.
Sourcepub fn agent_version(self, input: impl Into<String>) -> Self
pub fn agent_version(self, input: impl Into<String>) -> Self
The version of the agent.
Sourcepub fn set_agent_version(self, input: Option<String>) -> Self
pub fn set_agent_version(self, input: Option<String>) -> Self
The version of the agent.
Sourcepub fn get_agent_version(&self) -> &Option<String>
pub fn get_agent_version(&self) -> &Option<String>
The version of the agent.
Trait Implementations§
Source§impl Clone for TracePartBuilder
impl Clone for TracePartBuilder
Source§fn clone(&self) -> TracePartBuilder
fn clone(&self) -> TracePartBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TracePartBuilder
impl Debug for TracePartBuilder
Source§impl Default for TracePartBuilder
impl Default for TracePartBuilder
Source§fn default() -> TracePartBuilder
fn default() -> TracePartBuilder
Source§impl PartialEq for TracePartBuilder
impl PartialEq for TracePartBuilder
impl StructuralPartialEq for TracePartBuilder
Auto Trait Implementations§
impl Freeze for TracePartBuilder
impl RefUnwindSafe for TracePartBuilder
impl Send for TracePartBuilder
impl Sync for TracePartBuilder
impl Unpin for TracePartBuilder
impl UnwindSafe for TracePartBuilder
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);