#[non_exhaustive]pub struct MedicalScribeStreamDetails {Show 16 fields
pub session_id: Option<String>,
pub stream_created_at: Option<DateTime>,
pub stream_ended_at: Option<DateTime>,
pub language_code: Option<MedicalScribeLanguageCode>,
pub media_sample_rate_hertz: Option<i32>,
pub media_encoding: Option<MedicalScribeMediaEncoding>,
pub vocabulary_name: Option<String>,
pub vocabulary_filter_name: Option<String>,
pub vocabulary_filter_method: Option<MedicalScribeVocabularyFilterMethod>,
pub resource_access_role_arn: Option<String>,
pub channel_definitions: Option<Vec<MedicalScribeChannelDefinition>>,
pub encryption_settings: Option<MedicalScribeEncryptionSettings>,
pub stream_status: Option<MedicalScribeStreamStatus>,
pub post_stream_analytics_settings: Option<MedicalScribePostStreamAnalyticsSettings>,
pub post_stream_analytics_result: Option<MedicalScribePostStreamAnalyticsResult>,
pub medical_scribe_context_provided: Option<bool>,
}Expand description
Contains details about a Amazon Web Services HealthScribe streaming session.
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.session_id: Option<String>The identifier of the HealthScribe streaming session.
stream_created_at: Option<DateTime>The date and time when the HealthScribe streaming session was created.
stream_ended_at: Option<DateTime>The date and time when the HealthScribe streaming session was ended.
language_code: Option<MedicalScribeLanguageCode>The Language Code of the HealthScribe streaming session.
media_sample_rate_hertz: Option<i32>The sample rate (in hertz) of the HealthScribe streaming session.
media_encoding: Option<MedicalScribeMediaEncoding>The Media Encoding of the HealthScribe streaming session.
vocabulary_name: Option<String>The vocabulary name of the HealthScribe streaming session.
vocabulary_filter_name: Option<String>The name of the vocabulary filter used for the HealthScribe streaming session .
vocabulary_filter_method: Option<MedicalScribeVocabularyFilterMethod>The method of the vocabulary filter for the HealthScribe streaming session.
resource_access_role_arn: Option<String>The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.
channel_definitions: Option<Vec<MedicalScribeChannelDefinition>>The Channel Definitions of the HealthScribe streaming session.
encryption_settings: Option<MedicalScribeEncryptionSettings>The Encryption Settings of the HealthScribe streaming session.
stream_status: Option<MedicalScribeStreamStatus>The streaming status of the HealthScribe streaming session.
Possible Values:
-
IN_PROGRESS -
PAUSED -
FAILED -
COMPLETED
This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.
post_stream_analytics_settings: Option<MedicalScribePostStreamAnalyticsSettings>The post-stream analytics settings of the HealthScribe streaming session.
post_stream_analytics_result: Option<MedicalScribePostStreamAnalyticsResult>The result of post-stream analytics for the HealthScribe streaming session.
medical_scribe_context_provided: Option<bool>Indicates whether the MedicalScribeContext object was provided when the stream was started.
Implementations§
Source§impl MedicalScribeStreamDetails
impl MedicalScribeStreamDetails
Sourcepub fn session_id(&self) -> Option<&str>
pub fn session_id(&self) -> Option<&str>
The identifier of the HealthScribe streaming session.
Sourcepub fn stream_created_at(&self) -> Option<&DateTime>
pub fn stream_created_at(&self) -> Option<&DateTime>
The date and time when the HealthScribe streaming session was created.
Sourcepub fn stream_ended_at(&self) -> Option<&DateTime>
pub fn stream_ended_at(&self) -> Option<&DateTime>
The date and time when the HealthScribe streaming session was ended.
Sourcepub fn language_code(&self) -> Option<&MedicalScribeLanguageCode>
pub fn language_code(&self) -> Option<&MedicalScribeLanguageCode>
The Language Code of the HealthScribe streaming session.
Sourcepub fn media_sample_rate_hertz(&self) -> Option<i32>
pub fn media_sample_rate_hertz(&self) -> Option<i32>
The sample rate (in hertz) of the HealthScribe streaming session.
Sourcepub fn media_encoding(&self) -> Option<&MedicalScribeMediaEncoding>
pub fn media_encoding(&self) -> Option<&MedicalScribeMediaEncoding>
The Media Encoding of the HealthScribe streaming session.
Sourcepub fn vocabulary_name(&self) -> Option<&str>
pub fn vocabulary_name(&self) -> Option<&str>
The vocabulary name of the HealthScribe streaming session.
Sourcepub fn vocabulary_filter_name(&self) -> Option<&str>
pub fn vocabulary_filter_name(&self) -> Option<&str>
The name of the vocabulary filter used for the HealthScribe streaming session .
Sourcepub fn vocabulary_filter_method(
&self,
) -> Option<&MedicalScribeVocabularyFilterMethod>
pub fn vocabulary_filter_method( &self, ) -> Option<&MedicalScribeVocabularyFilterMethod>
The method of the vocabulary filter for the HealthScribe streaming session.
Sourcepub fn resource_access_role_arn(&self) -> Option<&str>
pub fn resource_access_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.
Sourcepub fn channel_definitions(&self) -> &[MedicalScribeChannelDefinition]
pub fn channel_definitions(&self) -> &[MedicalScribeChannelDefinition]
The Channel Definitions of the HealthScribe streaming session.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .channel_definitions.is_none().
Sourcepub fn encryption_settings(&self) -> Option<&MedicalScribeEncryptionSettings>
pub fn encryption_settings(&self) -> Option<&MedicalScribeEncryptionSettings>
The Encryption Settings of the HealthScribe streaming session.
Sourcepub fn stream_status(&self) -> Option<&MedicalScribeStreamStatus>
pub fn stream_status(&self) -> Option<&MedicalScribeStreamStatus>
The streaming status of the HealthScribe streaming session.
Possible Values:
-
IN_PROGRESS -
PAUSED -
FAILED -
COMPLETED
This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.
Sourcepub fn post_stream_analytics_settings(
&self,
) -> Option<&MedicalScribePostStreamAnalyticsSettings>
pub fn post_stream_analytics_settings( &self, ) -> Option<&MedicalScribePostStreamAnalyticsSettings>
The post-stream analytics settings of the HealthScribe streaming session.
Sourcepub fn post_stream_analytics_result(
&self,
) -> Option<&MedicalScribePostStreamAnalyticsResult>
pub fn post_stream_analytics_result( &self, ) -> Option<&MedicalScribePostStreamAnalyticsResult>
The result of post-stream analytics for the HealthScribe streaming session.
Sourcepub fn medical_scribe_context_provided(&self) -> Option<bool>
pub fn medical_scribe_context_provided(&self) -> Option<bool>
Indicates whether the MedicalScribeContext object was provided when the stream was started.
Source§impl MedicalScribeStreamDetails
impl MedicalScribeStreamDetails
Sourcepub fn builder() -> MedicalScribeStreamDetailsBuilder
pub fn builder() -> MedicalScribeStreamDetailsBuilder
Creates a new builder-style object to manufacture MedicalScribeStreamDetails.
Trait Implementations§
Source§impl Clone for MedicalScribeStreamDetails
impl Clone for MedicalScribeStreamDetails
Source§fn clone(&self) -> MedicalScribeStreamDetails
fn clone(&self) -> MedicalScribeStreamDetails
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for MedicalScribeStreamDetails
impl Debug for MedicalScribeStreamDetails
impl StructuralPartialEq for MedicalScribeStreamDetails
Auto Trait Implementations§
impl Freeze for MedicalScribeStreamDetails
impl RefUnwindSafe for MedicalScribeStreamDetails
impl Send for MedicalScribeStreamDetails
impl Sync for MedicalScribeStreamDetails
impl Unpin for MedicalScribeStreamDetails
impl UnwindSafe for MedicalScribeStreamDetails
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,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();§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.§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);