#[non_exhaustive]pub struct Channel {Show 20 fields
pub arn: Option<String>,
pub cdi_input_specification: Option<CdiInputSpecification>,
pub channel_class: Option<ChannelClass>,
pub destinations: Option<Vec<OutputDestination>>,
pub egress_endpoints: Option<Vec<ChannelEgressEndpoint>>,
pub encoder_settings: Option<EncoderSettings>,
pub id: Option<String>,
pub input_attachments: Option<Vec<InputAttachment>>,
pub input_specification: Option<InputSpecification>,
pub log_level: Option<LogLevel>,
pub maintenance: Option<MaintenanceStatus>,
pub name: Option<String>,
pub pipeline_details: Option<Vec<PipelineDetail>>,
pub pipelines_running_count: Option<i32>,
pub role_arn: Option<String>,
pub state: Option<ChannelState>,
pub tags: Option<HashMap<String, String>>,
pub vpc: Option<VpcOutputSettingsDescription>,
pub anywhere_settings: Option<DescribeAnywhereSettings>,
pub channel_engine_version: Option<ChannelEngineVersionResponse>,
}
Expand description
Placeholder documentation for Channel
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.arn: Option<String>
The unique arn of the channel.
cdi_input_specification: Option<CdiInputSpecification>
Specification of CDI inputs for this channel
channel_class: Option<ChannelClass>
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
destinations: Option<Vec<OutputDestination>>
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
egress_endpoints: Option<Vec<ChannelEgressEndpoint>>
The endpoints where outgoing connections initiate from
encoder_settings: Option<EncoderSettings>
Encoder Settings
id: Option<String>
The unique id of the channel.
input_attachments: Option<Vec<InputAttachment>>
List of input attachments for channel.
input_specification: Option<InputSpecification>
Specification of network and file inputs for this channel
log_level: Option<LogLevel>
The log level being written to CloudWatch Logs.
maintenance: Option<MaintenanceStatus>
Maintenance settings for this channel.
name: Option<String>
The name of the channel. (user-mutable)
pipeline_details: Option<Vec<PipelineDetail>>
Runtime details for the pipelines of a running channel.
pipelines_running_count: Option<i32>
The number of currently healthy pipelines.
role_arn: Option<String>
The Amazon Resource Name (ARN) of the role assumed when running the Channel.
state: Option<ChannelState>
Placeholder documentation for ChannelState
A collection of key-value pairs.
vpc: Option<VpcOutputSettingsDescription>
Settings for VPC output
anywhere_settings: Option<DescribeAnywhereSettings>
Anywhere settings for this channel.
channel_engine_version: Option<ChannelEngineVersionResponse>
Requested engine version for this channel.
Implementations§
Source§impl Channel
impl Channel
Sourcepub fn cdi_input_specification(&self) -> Option<&CdiInputSpecification>
pub fn cdi_input_specification(&self) -> Option<&CdiInputSpecification>
Specification of CDI inputs for this channel
Sourcepub fn channel_class(&self) -> Option<&ChannelClass>
pub fn channel_class(&self) -> Option<&ChannelClass>
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Sourcepub fn destinations(&self) -> &[OutputDestination]
pub fn destinations(&self) -> &[OutputDestination]
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destinations.is_none()
.
Sourcepub fn egress_endpoints(&self) -> &[ChannelEgressEndpoint]
pub fn egress_endpoints(&self) -> &[ChannelEgressEndpoint]
The endpoints where outgoing connections initiate from
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .egress_endpoints.is_none()
.
Sourcepub fn encoder_settings(&self) -> Option<&EncoderSettings>
pub fn encoder_settings(&self) -> Option<&EncoderSettings>
Encoder Settings
Sourcepub fn input_attachments(&self) -> &[InputAttachment]
pub fn input_attachments(&self) -> &[InputAttachment]
List of input attachments for channel.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .input_attachments.is_none()
.
Sourcepub fn input_specification(&self) -> Option<&InputSpecification>
pub fn input_specification(&self) -> Option<&InputSpecification>
Specification of network and file inputs for this channel
Sourcepub fn maintenance(&self) -> Option<&MaintenanceStatus>
pub fn maintenance(&self) -> Option<&MaintenanceStatus>
Maintenance settings for this channel.
Sourcepub fn pipeline_details(&self) -> &[PipelineDetail]
pub fn pipeline_details(&self) -> &[PipelineDetail]
Runtime details for the pipelines of a running channel.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .pipeline_details.is_none()
.
Sourcepub fn pipelines_running_count(&self) -> Option<i32>
pub fn pipelines_running_count(&self) -> Option<i32>
The number of currently healthy pipelines.
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the role assumed when running the Channel.
Sourcepub fn state(&self) -> Option<&ChannelState>
pub fn state(&self) -> Option<&ChannelState>
Placeholder documentation for ChannelState
A collection of key-value pairs.
Sourcepub fn vpc(&self) -> Option<&VpcOutputSettingsDescription>
pub fn vpc(&self) -> Option<&VpcOutputSettingsDescription>
Settings for VPC output
Sourcepub fn anywhere_settings(&self) -> Option<&DescribeAnywhereSettings>
pub fn anywhere_settings(&self) -> Option<&DescribeAnywhereSettings>
Anywhere settings for this channel.
Sourcepub fn channel_engine_version(&self) -> Option<&ChannelEngineVersionResponse>
pub fn channel_engine_version(&self) -> Option<&ChannelEngineVersionResponse>
Requested engine version for this channel.
Trait Implementations§
impl StructuralPartialEq for Channel
Auto Trait Implementations§
impl Freeze for Channel
impl RefUnwindSafe for Channel
impl Send for Channel
impl Sync for Channel
impl Unpin for Channel
impl UnwindSafe for Channel
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);