#[non_exhaustive]pub struct Flow {Show 17 fields
pub availability_zone: Option<String>,
pub description: Option<String>,
pub egress_ip: Option<String>,
pub entitlements: Option<Vec<Entitlement>>,
pub flow_arn: Option<String>,
pub media_streams: Option<Vec<MediaStream>>,
pub name: Option<String>,
pub outputs: Option<Vec<Output>>,
pub source: Option<Source>,
pub source_failover_config: Option<FailoverConfig>,
pub sources: Option<Vec<Source>>,
pub status: Option<Status>,
pub vpc_interfaces: Option<Vec<VpcInterface>>,
pub maintenance: Option<Maintenance>,
pub source_monitoring_config: Option<MonitoringConfig>,
pub flow_size: Option<FlowSize>,
pub ndi_config: Option<NdiConfig>,
}Expand description
The settings for a flow, including its source, outputs, and entitlements.
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.availability_zone: Option<String>The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
description: Option<String>A description of the flow. This value is not used or seen outside of the current MediaConnect account.
egress_ip: Option<String>The IP address from which video will be sent to output destinations.
entitlements: Option<Vec<Entitlement>>The entitlements in this flow.
flow_arn: Option<String>The Amazon Resource Name (ARN) of the flow.
media_streams: Option<Vec<MediaStream>>The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
name: Option<String>The name of the flow.
outputs: Option<Vec<Output>>The outputs in this flow.
source: Option<Source>The source for the flow.
source_failover_config: Option<FailoverConfig>The settings for the source failover.
sources: Option<Vec<Source>>The settings for the sources that are assigned to the flow.
status: Option<Status>The current status of the flow.
vpc_interfaces: Option<Vec<VpcInterface>>The VPC Interfaces for this flow.
maintenance: Option<Maintenance>The maintenance settings for the flow.
source_monitoring_config: Option<MonitoringConfig>The settings for source monitoring.
flow_size: Option<FlowSize>Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
ndi_config: Option<NdiConfig>Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
Implementations§
Source§impl Flow
impl Flow
Sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the flow. This value is not used or seen outside of the current MediaConnect account.
Sourcepub fn egress_ip(&self) -> Option<&str>
pub fn egress_ip(&self) -> Option<&str>
The IP address from which video will be sent to output destinations.
Sourcepub fn entitlements(&self) -> &[Entitlement]
pub fn entitlements(&self) -> &[Entitlement]
The entitlements in this flow.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .entitlements.is_none().
Sourcepub fn media_streams(&self) -> &[MediaStream]
pub fn media_streams(&self) -> &[MediaStream]
The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .media_streams.is_none().
Sourcepub fn outputs(&self) -> &[Output]
pub fn outputs(&self) -> &[Output]
The outputs in this flow.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .outputs.is_none().
Sourcepub fn source_failover_config(&self) -> Option<&FailoverConfig>
pub fn source_failover_config(&self) -> Option<&FailoverConfig>
The settings for the source failover.
Sourcepub fn sources(&self) -> &[Source]
pub fn sources(&self) -> &[Source]
The settings for the sources that are assigned to the flow.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sources.is_none().
Sourcepub fn vpc_interfaces(&self) -> &[VpcInterface]
pub fn vpc_interfaces(&self) -> &[VpcInterface]
The VPC Interfaces for this flow.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_interfaces.is_none().
Sourcepub fn maintenance(&self) -> Option<&Maintenance>
pub fn maintenance(&self) -> Option<&Maintenance>
The maintenance settings for the flow.
Sourcepub fn source_monitoring_config(&self) -> Option<&MonitoringConfig>
pub fn source_monitoring_config(&self) -> Option<&MonitoringConfig>
The settings for source monitoring.
Sourcepub fn flow_size(&self) -> Option<&FlowSize>
pub fn flow_size(&self) -> Option<&FlowSize>
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
Sourcepub fn ndi_config(&self) -> Option<&NdiConfig>
pub fn ndi_config(&self) -> Option<&NdiConfig>
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
Trait Implementations§
impl StructuralPartialEq for Flow
Auto Trait Implementations§
impl Freeze for Flow
impl RefUnwindSafe for Flow
impl Send for Flow
impl Sync for Flow
impl Unpin for Flow
impl UnwindSafe for Flow
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);