#[non_exhaustive]pub struct StreamBuilder { /* private fields */ }Expand description
A builder for Stream.
Implementations§
Source§impl StreamBuilder
impl StreamBuilder
Sourcepub fn channel_arn(self, input: impl Into<String>) -> Self
pub fn channel_arn(self, input: impl Into<String>) -> Self
Channel ARN for the stream.
Sourcepub fn set_channel_arn(self, input: Option<String>) -> Self
pub fn set_channel_arn(self, input: Option<String>) -> Self
Channel ARN for the stream.
Sourcepub fn get_channel_arn(&self) -> &Option<String>
pub fn get_channel_arn(&self) -> &Option<String>
Channel ARN for the stream.
Sourcepub fn stream_id(self, input: impl Into<String>) -> Self
pub fn stream_id(self, input: impl Into<String>) -> Self
Unique identifier for a live or previously live stream in the specified channel.
Sourcepub fn set_stream_id(self, input: Option<String>) -> Self
pub fn set_stream_id(self, input: Option<String>) -> Self
Unique identifier for a live or previously live stream in the specified channel.
Sourcepub fn get_stream_id(&self) -> &Option<String>
pub fn get_stream_id(&self) -> &Option<String>
Unique identifier for a live or previously live stream in the specified channel.
Sourcepub fn playback_url(self, input: impl Into<String>) -> Self
pub fn playback_url(self, input: impl Into<String>) -> Self
URL of the master playlist, required by the video player to play the HLS stream.
Sourcepub fn set_playback_url(self, input: Option<String>) -> Self
pub fn set_playback_url(self, input: Option<String>) -> Self
URL of the master playlist, required by the video player to play the HLS stream.
Sourcepub fn get_playback_url(&self) -> &Option<String>
pub fn get_playback_url(&self) -> &Option<String>
URL of the master playlist, required by the video player to play the HLS stream.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
Sourcepub fn state(self, input: StreamState) -> Self
pub fn state(self, input: StreamState) -> Self
The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
Sourcepub fn set_state(self, input: Option<StreamState>) -> Self
pub fn set_state(self, input: Option<StreamState>) -> Self
The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
Sourcepub fn get_state(&self) -> &Option<StreamState>
pub fn get_state(&self) -> &Option<StreamState>
The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
Sourcepub fn health(self, input: StreamHealth) -> Self
pub fn health(self, input: StreamHealth) -> Self
The stream’s health.
Sourcepub fn set_health(self, input: Option<StreamHealth>) -> Self
pub fn set_health(self, input: Option<StreamHealth>) -> Self
The stream’s health.
Sourcepub fn get_health(&self) -> &Option<StreamHealth>
pub fn get_health(&self) -> &Option<StreamHealth>
The stream’s health.
Sourcepub fn viewer_count(self, input: i64) -> Self
pub fn viewer_count(self, input: i64) -> Self
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
Sourcepub fn set_viewer_count(self, input: Option<i64>) -> Self
pub fn set_viewer_count(self, input: Option<i64>) -> Self
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
Sourcepub fn get_viewer_count(&self) -> &Option<i64>
pub fn get_viewer_count(&self) -> &Option<i64>
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
Trait Implementations§
Source§impl Clone for StreamBuilder
impl Clone for StreamBuilder
Source§fn clone(&self) -> StreamBuilder
fn clone(&self) -> StreamBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for StreamBuilder
impl Debug for StreamBuilder
Source§impl Default for StreamBuilder
impl Default for StreamBuilder
Source§fn default() -> StreamBuilder
fn default() -> StreamBuilder
Source§impl PartialEq for StreamBuilder
impl PartialEq for StreamBuilder
impl StructuralPartialEq for StreamBuilder
Auto Trait Implementations§
impl Freeze for StreamBuilder
impl RefUnwindSafe for StreamBuilder
impl Send for StreamBuilder
impl Sync for StreamBuilder
impl Unpin for StreamBuilder
impl UnwindSafe for StreamBuilder
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);