Struct MedicalScribeStreamDetailsBuilder Copy item path

impl MedicalScribeStreamDetailsBuilder

pub fn session_id(self, input: impl Into<String>) -> Self

The identifier of the HealthScribe streaming session.

pub fn set_session_id(self, input: Option<String>) -> Self

The identifier of the HealthScribe streaming session.

pub fn get_session_id(&self) -> &Option<String>

The identifier of the HealthScribe streaming session.

pub fn stream_created_at(self, input: DateTime) -> Self

The date and time when the HealthScribe streaming session was created.

pub fn set_stream_created_at(self, input: Option<DateTime>) -> Self

The date and time when the HealthScribe streaming session was created.

pub fn get_stream_created_at(&self) -> &Option<DateTime>

The date and time when the HealthScribe streaming session was created.

pub fn stream_ended_at(self, input: DateTime) -> Self

The date and time when the HealthScribe streaming session was ended.

pub fn set_stream_ended_at(self, input: Option<DateTime>) -> Self

The date and time when the HealthScribe streaming session was ended.

pub fn get_stream_ended_at(&self) -> &Option<DateTime>

The date and time when the HealthScribe streaming session was ended.

pub fn language_code(self, input: MedicalScribeLanguageCode) -> Self

The Language Code of the HealthScribe streaming session.

pub fn set_language_code(self, input: Option<MedicalScribeLanguageCode>) -> Self

The Language Code of the HealthScribe streaming session.

pub fn get_language_code(&self) -> &Option<MedicalScribeLanguageCode>

The Language Code of the HealthScribe streaming session.

pub fn media_sample_rate_hertz(self, input: i32) -> Self

The sample rate (in hertz) of the HealthScribe streaming session.

pub fn set_media_sample_rate_hertz(self, input: Option<i32>) -> Self

The sample rate (in hertz) of the HealthScribe streaming session.

pub fn get_media_sample_rate_hertz(&self) -> &Option<i32>

The sample rate (in hertz) of the HealthScribe streaming session.

pub fn media_encoding(self, input: MedicalScribeMediaEncoding) -> Self

The Media Encoding of the HealthScribe streaming session.

pub fn set_media_encoding( self, input: Option<MedicalScribeMediaEncoding>, ) -> Self

The Media Encoding of the HealthScribe streaming session.

pub fn get_media_encoding(&self) -> &Option<MedicalScribeMediaEncoding>

The Media Encoding of the HealthScribe streaming session.

pub fn vocabulary_name(self, input: impl Into<String>) -> Self

The vocabulary name of the HealthScribe streaming session.

pub fn set_vocabulary_name(self, input: Option<String>) -> Self

The vocabulary name of the HealthScribe streaming session.

pub fn get_vocabulary_name(&self) -> &Option<String>

The vocabulary name of the HealthScribe streaming session.

pub fn vocabulary_filter_name(self, input: impl Into<String>) -> Self

The name of the vocabulary filter used for the HealthScribe streaming session .

pub fn set_vocabulary_filter_name(self, input: Option<String>) -> Self

The name of the vocabulary filter used for the HealthScribe streaming session .

pub fn get_vocabulary_filter_name(&self) -> &Option<String>

The name of the vocabulary filter used for the HealthScribe streaming session .

pub fn vocabulary_filter_method( self, input: MedicalScribeVocabularyFilterMethod, ) -> Self

The method of the vocabulary filter for the HealthScribe streaming session.

pub fn set_vocabulary_filter_method( self, input: Option<MedicalScribeVocabularyFilterMethod>, ) -> Self

The method of the vocabulary filter for the HealthScribe streaming session.

pub fn get_vocabulary_filter_method( &self, ) -> &Option<MedicalScribeVocabularyFilterMethod>

The method of the vocabulary filter for the HealthScribe streaming session.

pub fn resource_access_role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.

pub fn set_resource_access_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.

pub fn get_resource_access_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.

pub fn channel_definitions(self, input: MedicalScribeChannelDefinition) -> Self

Appends an item to channel_definitions.

To override the contents of this collection use set_channel_definitions.

The Channel Definitions of the HealthScribe streaming session.

pub fn set_channel_definitions( self, input: Option<Vec<MedicalScribeChannelDefinition>>, ) -> Self

The Channel Definitions of the HealthScribe streaming session.

pub fn get_channel_definitions( &self, ) -> &Option<Vec<MedicalScribeChannelDefinition>>

The Channel Definitions of the HealthScribe streaming session.

pub fn encryption_settings(self, input: MedicalScribeEncryptionSettings) -> Self

The Encryption Settings of the HealthScribe streaming session.

pub fn set_encryption_settings( self, input: Option<MedicalScribeEncryptionSettings>, ) -> Self

The Encryption Settings of the HealthScribe streaming session.

pub fn get_encryption_settings( &self, ) -> &Option<MedicalScribeEncryptionSettings>

The Encryption Settings of the HealthScribe streaming session.

pub fn stream_status(self, input: MedicalScribeStreamStatus) -> Self

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.

pub fn set_stream_status(self, input: Option<MedicalScribeStreamStatus>) -> Self

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.

pub fn get_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.

pub fn post_stream_analytics_settings( self, input: MedicalScribePostStreamAnalyticsSettings, ) -> Self

The post-stream analytics settings of the HealthScribe streaming session.

pub fn set_post_stream_analytics_settings( self, input: Option<MedicalScribePostStreamAnalyticsSettings>, ) -> Self

The post-stream analytics settings of the HealthScribe streaming session.

pub fn get_post_stream_analytics_settings( &self, ) -> &Option<MedicalScribePostStreamAnalyticsSettings>

The post-stream analytics settings of the HealthScribe streaming session.

pub fn post_stream_analytics_result( self, input: MedicalScribePostStreamAnalyticsResult, ) -> Self

The result of post-stream analytics for the HealthScribe streaming session.

pub fn set_post_stream_analytics_result( self, input: Option<MedicalScribePostStreamAnalyticsResult>, ) -> Self

The result of post-stream analytics for the HealthScribe streaming session.

pub fn get_post_stream_analytics_result( &self, ) -> &Option<MedicalScribePostStreamAnalyticsResult>

The result of post-stream analytics for the HealthScribe streaming session.

pub fn medical_scribe_context_provided(self, input: bool) -> Self

Indicates whether the MedicalScribeContext object was provided when the stream was started.

pub fn set_medical_scribe_context_provided(self, input: Option<bool>) -> Self

Indicates whether the MedicalScribeContext object was provided when the stream was started.

pub fn get_medical_scribe_context_provided(&self) -> &Option<bool>

Indicates whether the MedicalScribeContext object was provided when the stream was started.

pub fn build(self) -> MedicalScribeStreamDetails

Consumes the builder and constructs a MedicalScribeStreamDetails.

Trait Implementations§

impl Clone for MedicalScribeStreamDetailsBuilder

fn clone(&self) -> MedicalScribeStreamDetailsBuilder

Returns a copy of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for MedicalScribeStreamDetailsBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for MedicalScribeStreamDetailsBuilder

fn default() -> MedicalScribeStreamDetailsBuilder

Returns the “default value” for a type. Read more

impl PartialEq for MedicalScribeStreamDetailsBuilder

fn eq(&self, other: &MedicalScribeStreamDetailsBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MedicalScribeStreamDetailsBuilder

Auto Trait Implementations§

impl UnwindSafe for MedicalScribeStreamDetailsBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Paint for T
where T: ?Sized,

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example

println!("{}", value.primary());

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example

println!("{}", value.fixed(color));

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example

println!("{}", value.rgb(r, g, b));

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example

println!("{}", value.black());

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example

println!("{}", value.red());

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example

println!("{}", value.green());

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example

println!("{}", value.yellow());

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example

println!("{}", value.blue());

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example

println!("{}", value.magenta());

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example

println!("{}", value.cyan());

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example

println!("{}", value.white());

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example

println!("{}", value.bright_black());

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example

println!("{}", value.bright_red());

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example

println!("{}", value.bright_green());

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example

println!("{}", value.bright_yellow());

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example

println!("{}", value.bright_blue());

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.bright_magenta());

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example

println!("{}", value.bright_cyan());

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example

println!("{}", value.bright_white());

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>

Returns self with the bg() set to [Color :: Primary].

§Example

println!("{}", value.on_primary());

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example

println!("{}", value.on_fixed(color));

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example

println!("{}", value.on_rgb(r, g, b));

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example

println!("{}", value.on_black());

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example

println!("{}", value.on_red());

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example

println!("{}", value.on_green());

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example

println!("{}", value.on_yellow());

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example

println!("{}", value.on_blue());

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example

println!("{}", value.on_magenta());

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example

println!("{}", value.on_cyan());

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example

println!("{}", value.on_white());

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example

println!("{}", value.on_bright_black());

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example

println!("{}", value.on_bright_red());

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example

println!("{}", value.on_bright_green());

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example

println!("{}", value.on_bright_yellow());

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example

println!("{}", value.on_bright_blue());

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.on_bright_magenta());

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example

println!("{}", value.on_bright_cyan());

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example

println!("{}", value.on_bright_white());

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example

println!("{}", value.bold());

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example

println!("{}", value.dim());

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example

println!("{}", value.italic());

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example

println!("{}", value.underline());

fn blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Blink].

§Example

println!("{}", value.blink());

fn rapid_blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example

println!("{}", value.rapid_blink());

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example

println!("{}", value.invert());

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example

println!("{}", value.conceal());

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example

println!("{}", value.strike());

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example

println!("{}", value.mask());

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example

println!("{}", value.wrap());

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example

println!("{}", value.linger());

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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example

println!("{}", value.clear());

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example

println!("{}", value.resetting());

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example

println!("{}", value.bright());

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example

println!("{}", value.on_bright());

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);

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new [Painted] with a default [Style]. Read more

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more