OutputBuilder

Struct OutputBuilder 

Source
#[non_exhaustive]
pub struct OutputBuilder { /* private fields */ }
Expand description

A builder for Output.

Implementations§

Source§

impl OutputBuilder

Source

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

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

Source

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

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

Source

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

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

Source

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

A description of the output.

Source

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

A description of the output.

Source

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

A description of the output.

Source

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

The address where you want to send the output.

Source

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

The address where you want to send the output.

Source

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

The address where you want to send the output.

Source

pub fn encryption(self, input: Encryption) -> Self

The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Source

pub fn set_encryption(self, input: Option<Encryption>) -> Self

The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Source

pub fn get_encryption(&self) -> &Option<Encryption>

The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Source

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

The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.

Source

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

The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.

Source

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

The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.

Source

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

The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.

Source

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

The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.

Source

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

The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.

Source

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

The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.

Source

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

The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.

Source

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

The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.

Source

pub fn media_stream_output_configurations( self, input: MediaStreamOutputConfiguration, ) -> Self

Appends an item to media_stream_output_configurations.

To override the contents of this collection use set_media_stream_output_configurations.

The configuration for each media stream that is associated with the output.

Source

pub fn set_media_stream_output_configurations( self, input: Option<Vec<MediaStreamOutputConfiguration>>, ) -> Self

The configuration for each media stream that is associated with the output.

Source

pub fn get_media_stream_output_configurations( &self, ) -> &Option<Vec<MediaStreamOutputConfiguration>>

The configuration for each media stream that is associated with the output.

Source

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

The name of the output. This value must be unique within the current flow.

This field is required.
Source

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

The name of the output. This value must be unique within the current flow.

Source

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

The name of the output. This value must be unique within the current flow.

Source

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

The ARN of the output.

This field is required.
Source

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

The ARN of the output.

Source

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

The ARN of the output.

Source

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

The port to use when content is distributed to this output.

Source

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

The port to use when content is distributed to this output.

Source

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

The port to use when content is distributed to this output.

Source

pub fn transport(self, input: Transport) -> Self

Attributes related to the transport stream that are used in the output.

Source

pub fn set_transport(self, input: Option<Transport>) -> Self

Attributes related to the transport stream that are used in the output.

Source

pub fn get_transport(&self) -> &Option<Transport>

Attributes related to the transport stream that are used in the output.

Source

pub fn vpc_interface_attachment(self, input: VpcInterfaceAttachment) -> Self

The name of the VPC interface attachment to use for this output.

Source

pub fn set_vpc_interface_attachment( self, input: Option<VpcInterfaceAttachment>, ) -> Self

The name of the VPC interface attachment to use for this output.

Source

pub fn get_vpc_interface_attachment(&self) -> &Option<VpcInterfaceAttachment>

The name of the VPC interface attachment to use for this output.

Source

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

The ARN of the bridge added to this output.

Source

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

The ARN of the bridge added to this output.

Source

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

The ARN of the bridge added to this output.

Source

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

Appends an item to bridge_ports.

To override the contents of this collection use set_bridge_ports.

The bridge output ports currently in use.

Source

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

The bridge output ports currently in use.

Source

pub fn get_bridge_ports(&self) -> &Option<Vec<i32>>

The bridge output ports currently in use.

Source

pub fn output_status(self, input: OutputStatus) -> Self

An indication of whether the output is transmitting data or not.

Source

pub fn set_output_status(self, input: Option<OutputStatus>) -> Self

An indication of whether the output is transmitting data or not.

Source

pub fn get_output_status(&self) -> &Option<OutputStatus>

An indication of whether the output is transmitting data or not.

Source

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

The IP address of the device that is currently receiving content from this output.

  • For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.

  • For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.

  • Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.

  • The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.

Source

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

The IP address of the device that is currently receiving content from this output.

  • For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.

  • For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.

  • Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.

  • The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.

Source

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

The IP address of the device that is currently receiving content from this output.

  • For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.

  • For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.

  • Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.

  • The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.

Source

pub fn build(self) -> Output

Consumes the builder and constructs a Output.

Trait Implementations§

Source§

impl Clone for OutputBuilder

Source§

fn clone(&self) -> OutputBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OutputBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OutputBuilder

Source§

fn default() -> OutputBuilder

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

impl PartialEq for OutputBuilder

Source§

fn eq(&self, other: &OutputBuilder) -> 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.
Source§

impl StructuralPartialEq for OutputBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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
Source§

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
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

§Example
println!("{}", value.linger());
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.

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

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

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

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

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

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

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

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

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

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

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

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

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

Create a new Painted with a default Style. Read more
Source§

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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,