#[non_exhaustive]pub struct AgenticRetrieveTraceEventAttributes {
pub step: AgenticRetrieveStep,
pub status: AgenticRetrieveStatus,
pub message: String,
pub actions: Option<Vec<AgenticRetrieveAction>>,
pub warnings: Option<Vec<AgenticRetrieveWarning>>,
pub failures: Option<Vec<AgenticRetrieveFailure>>,
pub retrieval_metadata: Option<Vec<AgenticRetrieveSourceMetadata>>,
pub retrieval_response: Option<Vec<AgenticRetrieveTraceResultItem>>,
}Expand description
Attributes describing the details of an agentic retrieval trace event.
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.step: AgenticRetrieveStepThe current step in the retrieval process.
status: AgenticRetrieveStatusThe status of the current step.
message: StringA human-readable message describing the trace event.
actions: Option<Vec<AgenticRetrieveAction>>The list of actions taken during this step.
warnings: Option<Vec<AgenticRetrieveWarning>>Warnings generated during this step.
failures: Option<Vec<AgenticRetrieveFailure>>Failures that occurred during this step.
retrieval_metadata: Option<Vec<AgenticRetrieveSourceMetadata>>Metadata about the retrieval sources used.
retrieval_response: Option<Vec<AgenticRetrieveTraceResultItem>>The retrieval results from this step.
Implementations§
Source§impl AgenticRetrieveTraceEventAttributes
impl AgenticRetrieveTraceEventAttributes
Sourcepub fn step(&self) -> &AgenticRetrieveStep
pub fn step(&self) -> &AgenticRetrieveStep
The current step in the retrieval process.
Sourcepub fn status(&self) -> &AgenticRetrieveStatus
pub fn status(&self) -> &AgenticRetrieveStatus
The status of the current step.
Sourcepub fn actions(&self) -> &[AgenticRetrieveAction]
pub fn actions(&self) -> &[AgenticRetrieveAction]
The list of actions taken during this step.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .actions.is_none().
Sourcepub fn warnings(&self) -> &[AgenticRetrieveWarning]
pub fn warnings(&self) -> &[AgenticRetrieveWarning]
Warnings generated during this step.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .warnings.is_none().
Sourcepub fn failures(&self) -> &[AgenticRetrieveFailure]
pub fn failures(&self) -> &[AgenticRetrieveFailure]
Failures that occurred during this step.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .failures.is_none().
Sourcepub fn retrieval_metadata(&self) -> &[AgenticRetrieveSourceMetadata]
pub fn retrieval_metadata(&self) -> &[AgenticRetrieveSourceMetadata]
Metadata about the retrieval sources used.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .retrieval_metadata.is_none().
Sourcepub fn retrieval_response(&self) -> &[AgenticRetrieveTraceResultItem]
pub fn retrieval_response(&self) -> &[AgenticRetrieveTraceResultItem]
The retrieval results from this step.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .retrieval_response.is_none().
Source§impl AgenticRetrieveTraceEventAttributes
impl AgenticRetrieveTraceEventAttributes
Sourcepub fn builder() -> AgenticRetrieveTraceEventAttributesBuilder
pub fn builder() -> AgenticRetrieveTraceEventAttributesBuilder
Creates a new builder-style object to manufacture AgenticRetrieveTraceEventAttributes.
Trait Implementations§
Source§impl Clone for AgenticRetrieveTraceEventAttributes
impl Clone for AgenticRetrieveTraceEventAttributes
Source§fn clone(&self) -> AgenticRetrieveTraceEventAttributes
fn clone(&self) -> AgenticRetrieveTraceEventAttributes
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl PartialEq for AgenticRetrieveTraceEventAttributes
impl PartialEq for AgenticRetrieveTraceEventAttributes
Source§fn eq(&self, other: &AgenticRetrieveTraceEventAttributes) -> bool
fn eq(&self, other: &AgenticRetrieveTraceEventAttributes) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for AgenticRetrieveTraceEventAttributes
Auto Trait Implementations§
impl Freeze for AgenticRetrieveTraceEventAttributes
impl RefUnwindSafe for AgenticRetrieveTraceEventAttributes
impl Send for AgenticRetrieveTraceEventAttributes
impl Sync for AgenticRetrieveTraceEventAttributes
impl Unpin for AgenticRetrieveTraceEventAttributes
impl UnsafeUnpin for AgenticRetrieveTraceEventAttributes
impl UnwindSafe for AgenticRetrieveTraceEventAttributes
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);