#[non_exhaustive]pub struct StartMedicalScribeStreamOutput {
pub session_id: Option<String>,
pub request_id: Option<String>,
pub language_code: Option<MedicalScribeLanguageCode>,
pub media_sample_rate_hertz: Option<i32>,
pub media_encoding: Option<MedicalScribeMediaEncoding>,
pub result_stream: EventReceiver<MedicalScribeResultStream, MedicalScribeResultStreamError>,
/* private fields */
}
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 (in UUID format) for your streaming session.
If you already started streaming, this is same ID as the one you specified in your initial StartMedicalScribeStreamRequest
.
request_id: Option<String>
The unique identifier for your streaming request.
language_code: Option<MedicalScribeLanguageCode>
The Language Code that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
.
media_sample_rate_hertz: Option<i32>
The sample rate (in hertz) that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
media_encoding: Option<MedicalScribeMediaEncoding>
The Media Encoding you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
result_stream: EventReceiver<MedicalScribeResultStream, MedicalScribeResultStreamError>
The result stream where you will receive the output events.
Implementations§
Source§impl StartMedicalScribeStreamOutput
impl StartMedicalScribeStreamOutput
Sourcepub fn session_id(&self) -> Option<&str>
pub fn session_id(&self) -> Option<&str>
The identifier (in UUID format) for your streaming session.
If you already started streaming, this is same ID as the one you specified in your initial StartMedicalScribeStreamRequest
.
Sourcepub fn request_id(&self) -> Option<&str>
pub fn request_id(&self) -> Option<&str>
The unique identifier for your streaming request.
Sourcepub fn language_code(&self) -> Option<&MedicalScribeLanguageCode>
pub fn language_code(&self) -> Option<&MedicalScribeLanguageCode>
The Language Code that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
.
Sourcepub fn media_sample_rate_hertz(&self) -> Option<i32>
pub fn media_sample_rate_hertz(&self) -> Option<i32>
The sample rate (in hertz) that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
Sourcepub fn media_encoding(&self) -> Option<&MedicalScribeMediaEncoding>
pub fn media_encoding(&self) -> Option<&MedicalScribeMediaEncoding>
The Media Encoding you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
Sourcepub fn result_stream(
&self,
) -> &EventReceiver<MedicalScribeResultStream, MedicalScribeResultStreamError>
pub fn result_stream( &self, ) -> &EventReceiver<MedicalScribeResultStream, MedicalScribeResultStreamError>
The result stream where you will receive the output events.
Source§impl StartMedicalScribeStreamOutput
impl StartMedicalScribeStreamOutput
Sourcepub fn builder() -> StartMedicalScribeStreamOutputBuilder
pub fn builder() -> StartMedicalScribeStreamOutputBuilder
Creates a new builder-style object to manufacture StartMedicalScribeStreamOutput
.
Trait Implementations§
Source§impl RequestId for StartMedicalScribeStreamOutput
impl RequestId for StartMedicalScribeStreamOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.Auto Trait Implementations§
impl !Freeze for StartMedicalScribeStreamOutput
impl !RefUnwindSafe for StartMedicalScribeStreamOutput
impl Send for StartMedicalScribeStreamOutput
impl Sync for StartMedicalScribeStreamOutput
impl Unpin for StartMedicalScribeStreamOutput
impl !UnwindSafe for StartMedicalScribeStreamOutput
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<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);