#[non_exhaustive]pub struct AgenticRetrieveTraceEventAttributesBuilder { /* private fields */ }Expand description
A builder for AgenticRetrieveTraceEventAttributes.
Implementations§
Source§impl AgenticRetrieveTraceEventAttributesBuilder
impl AgenticRetrieveTraceEventAttributesBuilder
Sourcepub fn step(self, input: AgenticRetrieveStep) -> Self
pub fn step(self, input: AgenticRetrieveStep) -> Self
The current step in the retrieval process.
This field is required.Sourcepub fn set_step(self, input: Option<AgenticRetrieveStep>) -> Self
pub fn set_step(self, input: Option<AgenticRetrieveStep>) -> Self
The current step in the retrieval process.
Sourcepub fn get_step(&self) -> &Option<AgenticRetrieveStep>
pub fn get_step(&self) -> &Option<AgenticRetrieveStep>
The current step in the retrieval process.
Sourcepub fn status(self, input: AgenticRetrieveStatus) -> Self
pub fn status(self, input: AgenticRetrieveStatus) -> Self
The status of the current step.
This field is required.Sourcepub fn set_status(self, input: Option<AgenticRetrieveStatus>) -> Self
pub fn set_status(self, input: Option<AgenticRetrieveStatus>) -> Self
The status of the current step.
Sourcepub fn get_status(&self) -> &Option<AgenticRetrieveStatus>
pub fn get_status(&self) -> &Option<AgenticRetrieveStatus>
The status of the current step.
Sourcepub fn message(self, input: impl Into<String>) -> Self
pub fn message(self, input: impl Into<String>) -> Self
A human-readable message describing the trace event.
This field is required.Sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
A human-readable message describing the trace event.
Sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
A human-readable message describing the trace event.
Sourcepub fn actions(self, input: AgenticRetrieveAction) -> Self
pub fn actions(self, input: AgenticRetrieveAction) -> Self
Appends an item to actions.
To override the contents of this collection use set_actions.
The list of actions taken during this step.
Sourcepub fn set_actions(self, input: Option<Vec<AgenticRetrieveAction>>) -> Self
pub fn set_actions(self, input: Option<Vec<AgenticRetrieveAction>>) -> Self
The list of actions taken during this step.
Sourcepub fn get_actions(&self) -> &Option<Vec<AgenticRetrieveAction>>
pub fn get_actions(&self) -> &Option<Vec<AgenticRetrieveAction>>
The list of actions taken during this step.
Sourcepub fn warnings(self, input: AgenticRetrieveWarning) -> Self
pub fn warnings(self, input: AgenticRetrieveWarning) -> Self
Appends an item to warnings.
To override the contents of this collection use set_warnings.
Warnings generated during this step.
Sourcepub fn set_warnings(self, input: Option<Vec<AgenticRetrieveWarning>>) -> Self
pub fn set_warnings(self, input: Option<Vec<AgenticRetrieveWarning>>) -> Self
Warnings generated during this step.
Sourcepub fn get_warnings(&self) -> &Option<Vec<AgenticRetrieveWarning>>
pub fn get_warnings(&self) -> &Option<Vec<AgenticRetrieveWarning>>
Warnings generated during this step.
Sourcepub fn failures(self, input: AgenticRetrieveFailure) -> Self
pub fn failures(self, input: AgenticRetrieveFailure) -> Self
Appends an item to failures.
To override the contents of this collection use set_failures.
Failures that occurred during this step.
Sourcepub fn set_failures(self, input: Option<Vec<AgenticRetrieveFailure>>) -> Self
pub fn set_failures(self, input: Option<Vec<AgenticRetrieveFailure>>) -> Self
Failures that occurred during this step.
Sourcepub fn get_failures(&self) -> &Option<Vec<AgenticRetrieveFailure>>
pub fn get_failures(&self) -> &Option<Vec<AgenticRetrieveFailure>>
Failures that occurred during this step.
Sourcepub fn retrieval_metadata(self, input: AgenticRetrieveSourceMetadata) -> Self
pub fn retrieval_metadata(self, input: AgenticRetrieveSourceMetadata) -> Self
Appends an item to retrieval_metadata.
To override the contents of this collection use set_retrieval_metadata.
Metadata about the retrieval sources used.
Sourcepub fn set_retrieval_metadata(
self,
input: Option<Vec<AgenticRetrieveSourceMetadata>>,
) -> Self
pub fn set_retrieval_metadata( self, input: Option<Vec<AgenticRetrieveSourceMetadata>>, ) -> Self
Metadata about the retrieval sources used.
Sourcepub fn get_retrieval_metadata(
&self,
) -> &Option<Vec<AgenticRetrieveSourceMetadata>>
pub fn get_retrieval_metadata( &self, ) -> &Option<Vec<AgenticRetrieveSourceMetadata>>
Metadata about the retrieval sources used.
Sourcepub fn retrieval_response(self, input: AgenticRetrieveTraceResultItem) -> Self
pub fn retrieval_response(self, input: AgenticRetrieveTraceResultItem) -> Self
Appends an item to retrieval_response.
To override the contents of this collection use set_retrieval_response.
The retrieval results from this step.
Sourcepub fn set_retrieval_response(
self,
input: Option<Vec<AgenticRetrieveTraceResultItem>>,
) -> Self
pub fn set_retrieval_response( self, input: Option<Vec<AgenticRetrieveTraceResultItem>>, ) -> Self
The retrieval results from this step.
Sourcepub fn get_retrieval_response(
&self,
) -> &Option<Vec<AgenticRetrieveTraceResultItem>>
pub fn get_retrieval_response( &self, ) -> &Option<Vec<AgenticRetrieveTraceResultItem>>
The retrieval results from this step.
Sourcepub fn build(self) -> Result<AgenticRetrieveTraceEventAttributes, BuildError>
pub fn build(self) -> Result<AgenticRetrieveTraceEventAttributes, BuildError>
Consumes the builder and constructs a AgenticRetrieveTraceEventAttributes.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AgenticRetrieveTraceEventAttributesBuilder
impl Clone for AgenticRetrieveTraceEventAttributesBuilder
Source§fn clone(&self) -> AgenticRetrieveTraceEventAttributesBuilder
fn clone(&self) -> AgenticRetrieveTraceEventAttributesBuilder
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for AgenticRetrieveTraceEventAttributesBuilder
impl Default for AgenticRetrieveTraceEventAttributesBuilder
Source§fn default() -> AgenticRetrieveTraceEventAttributesBuilder
fn default() -> AgenticRetrieveTraceEventAttributesBuilder
Source§impl PartialEq for AgenticRetrieveTraceEventAttributesBuilder
impl PartialEq for AgenticRetrieveTraceEventAttributesBuilder
Source§fn eq(&self, other: &AgenticRetrieveTraceEventAttributesBuilder) -> bool
fn eq(&self, other: &AgenticRetrieveTraceEventAttributesBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for AgenticRetrieveTraceEventAttributesBuilder
Auto Trait Implementations§
impl Freeze for AgenticRetrieveTraceEventAttributesBuilder
impl RefUnwindSafe for AgenticRetrieveTraceEventAttributesBuilder
impl Send for AgenticRetrieveTraceEventAttributesBuilder
impl Sync for AgenticRetrieveTraceEventAttributesBuilder
impl Unpin for AgenticRetrieveTraceEventAttributesBuilder
impl UnsafeUnpin for AgenticRetrieveTraceEventAttributesBuilder
impl UnwindSafe for AgenticRetrieveTraceEventAttributesBuilder
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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>
renamed to 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);