#[non_exhaustive]pub enum DataDetails {
ContentData(ContentDataDetails),
GenerativeChunkData(GenerativeChunkDataDetails),
GenerativeData(GenerativeDataDetails),
IntentDetectedData(IntentDetectedDataDetails),
SourceContentData(SourceContentDataDetails),
#[non_exhaustive] Unknown,
}
Expand description
Details about the data.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
ContentData(ContentDataDetails)
Details about the content data.
GenerativeChunkData(GenerativeChunkDataDetails)
Details about the generative chunk data.
GenerativeData(GenerativeDataDetails)
Details about the generative data.
IntentDetectedData(IntentDetectedDataDetails)
Details about the intent data.
SourceContentData(SourceContentDataDetails)
Details about the content data.
#[non_exhaustive]Unknown
The Unknown
variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version.
An unknown enum variant
Note: If you encounter this error, consider upgrading your SDK to the latest version.
The Unknown
variant represents cases where the server sent a value that wasn’t recognized
by the client. This can happen when the server adds new functionality, but the client has not been updated.
To investigate this, consider turning on debug logging to print the raw HTTP response.
Implementations§
Source§impl DataDetails
impl DataDetails
Sourcepub fn as_content_data(&self) -> Result<&ContentDataDetails, &Self>
pub fn as_content_data(&self) -> Result<&ContentDataDetails, &Self>
Tries to convert the enum instance into ContentData
, extracting the inner ContentDataDetails
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_content_data(&self) -> bool
pub fn is_content_data(&self) -> bool
Returns true if this is a ContentData
.
Sourcepub fn as_generative_chunk_data(
&self,
) -> Result<&GenerativeChunkDataDetails, &Self>
pub fn as_generative_chunk_data( &self, ) -> Result<&GenerativeChunkDataDetails, &Self>
Tries to convert the enum instance into GenerativeChunkData
, extracting the inner GenerativeChunkDataDetails
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_generative_chunk_data(&self) -> bool
pub fn is_generative_chunk_data(&self) -> bool
Returns true if this is a GenerativeChunkData
.
Sourcepub fn as_generative_data(&self) -> Result<&GenerativeDataDetails, &Self>
pub fn as_generative_data(&self) -> Result<&GenerativeDataDetails, &Self>
Tries to convert the enum instance into GenerativeData
, extracting the inner GenerativeDataDetails
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_generative_data(&self) -> bool
pub fn is_generative_data(&self) -> bool
Returns true if this is a GenerativeData
.
Sourcepub fn as_intent_detected_data(
&self,
) -> Result<&IntentDetectedDataDetails, &Self>
pub fn as_intent_detected_data( &self, ) -> Result<&IntentDetectedDataDetails, &Self>
Tries to convert the enum instance into IntentDetectedData
, extracting the inner IntentDetectedDataDetails
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_intent_detected_data(&self) -> bool
pub fn is_intent_detected_data(&self) -> bool
Returns true if this is a IntentDetectedData
.
Sourcepub fn as_source_content_data(&self) -> Result<&SourceContentDataDetails, &Self>
pub fn as_source_content_data(&self) -> Result<&SourceContentDataDetails, &Self>
Tries to convert the enum instance into SourceContentData
, extracting the inner SourceContentDataDetails
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_source_content_data(&self) -> bool
pub fn is_source_content_data(&self) -> bool
Returns true if this is a SourceContentData
.
Sourcepub fn is_unknown(&self) -> bool
pub fn is_unknown(&self) -> bool
Returns true if the enum instance is the Unknown
variant.
Trait Implementations§
Source§impl Clone for DataDetails
impl Clone for DataDetails
Source§fn clone(&self) -> DataDetails
fn clone(&self) -> DataDetails
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DataDetails
impl Debug for DataDetails
Source§impl PartialEq for DataDetails
impl PartialEq for DataDetails
impl StructuralPartialEq for DataDetails
Auto Trait Implementations§
impl Freeze for DataDetails
impl RefUnwindSafe for DataDetails
impl Send for DataDetails
impl Sync for DataDetails
impl Unpin for DataDetails
impl UnwindSafe for DataDetails
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);