#[non_exhaustive]pub struct EventBuilder { /* private fields */ }Expand description
A builder for Event.
Implementations§
Source§impl EventBuilder
impl EventBuilder
Sourcepub fn participant_id(self, input: impl Into<String>) -> Self
pub fn participant_id(self, input: impl Into<String>) -> Self
Unique identifier for the participant who triggered the event. This is assigned by IVS.
Sourcepub fn set_participant_id(self, input: Option<String>) -> Self
pub fn set_participant_id(self, input: Option<String>) -> Self
Unique identifier for the participant who triggered the event. This is assigned by IVS.
Sourcepub fn get_participant_id(&self) -> &Option<String>
pub fn get_participant_id(&self) -> &Option<String>
Unique identifier for the participant who triggered the event. This is assigned by IVS.
Sourcepub fn event_time(self, input: DateTime) -> Self
pub fn event_time(self, input: DateTime) -> Self
ISO 8601 timestamp (returned as a string) for when the event occurred.
Sourcepub fn set_event_time(self, input: Option<DateTime>) -> Self
pub fn set_event_time(self, input: Option<DateTime>) -> Self
ISO 8601 timestamp (returned as a string) for when the event occurred.
Sourcepub fn get_event_time(&self) -> &Option<DateTime>
pub fn get_event_time(&self) -> &Option<DateTime>
ISO 8601 timestamp (returned as a string) for when the event occurred.
Sourcepub fn remote_participant_id(self, input: impl Into<String>) -> Self
pub fn remote_participant_id(self, input: impl Into<String>) -> Self
Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
Sourcepub fn set_remote_participant_id(self, input: Option<String>) -> Self
pub fn set_remote_participant_id(self, input: Option<String>) -> Self
Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
Sourcepub fn get_remote_participant_id(&self) -> &Option<String>
pub fn get_remote_participant_id(&self) -> &Option<String>
Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
Sourcepub fn error_code(self, input: EventErrorCode) -> Self
pub fn error_code(self, input: EventErrorCode) -> Self
If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.
-
B_FRAME_PRESENT— The participant's stream includes B-frames. For details, see IVS RTMP Publishing. -
BITRATE_EXCEEDED— The participant exceeded the maximum supported bitrate. For details, see Service Quotas. -
INSUFFICIENT_CAPABILITIES— The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see thecapabilitiesfield inCreateParticipantToken. -
INTERNAL_SERVER_EXCEPTION— The participant failed to publish to the stage due to an internal server error. -
INVALID_AUDIO_CODEC— The participant is using an invalid audio codec. For details, see Stream Ingest. -
INVALID_INPUT— The participant is using an invalid input stream. -
INVALID_PROTOCOL— The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing. -
INVALID_STREAM_KEY— The participant is using an invalid stream key. For details, see IVS RTMP Publishing. -
INVALID_VIDEO_CODEC— The participant is using an invalid video codec. For details, see Stream Ingest. -
PUBLISHER_NOT_FOUND— The participant tried to subscribe to a publisher that doesn’t exist. -
QUOTA_EXCEEDED— The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas. -
RESOLUTION_EXCEEDED— The participant exceeded the maximum supported resolution. For details, see Service Quotas. -
REUSE_OF_STREAM_KEY— The participant tried to use a stream key that is associated with another active stage session. -
STREAM_DURATION_EXCEEDED— The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.
Sourcepub fn set_error_code(self, input: Option<EventErrorCode>) -> Self
pub fn set_error_code(self, input: Option<EventErrorCode>) -> Self
If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.
-
B_FRAME_PRESENT— The participant's stream includes B-frames. For details, see IVS RTMP Publishing. -
BITRATE_EXCEEDED— The participant exceeded the maximum supported bitrate. For details, see Service Quotas. -
INSUFFICIENT_CAPABILITIES— The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see thecapabilitiesfield inCreateParticipantToken. -
INTERNAL_SERVER_EXCEPTION— The participant failed to publish to the stage due to an internal server error. -
INVALID_AUDIO_CODEC— The participant is using an invalid audio codec. For details, see Stream Ingest. -
INVALID_INPUT— The participant is using an invalid input stream. -
INVALID_PROTOCOL— The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing. -
INVALID_STREAM_KEY— The participant is using an invalid stream key. For details, see IVS RTMP Publishing. -
INVALID_VIDEO_CODEC— The participant is using an invalid video codec. For details, see Stream Ingest. -
PUBLISHER_NOT_FOUND— The participant tried to subscribe to a publisher that doesn’t exist. -
QUOTA_EXCEEDED— The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas. -
RESOLUTION_EXCEEDED— The participant exceeded the maximum supported resolution. For details, see Service Quotas. -
REUSE_OF_STREAM_KEY— The participant tried to use a stream key that is associated with another active stage session. -
STREAM_DURATION_EXCEEDED— The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.
Sourcepub fn get_error_code(&self) -> &Option<EventErrorCode>
pub fn get_error_code(&self) -> &Option<EventErrorCode>
If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.
-
B_FRAME_PRESENT— The participant's stream includes B-frames. For details, see IVS RTMP Publishing. -
BITRATE_EXCEEDED— The participant exceeded the maximum supported bitrate. For details, see Service Quotas. -
INSUFFICIENT_CAPABILITIES— The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see thecapabilitiesfield inCreateParticipantToken. -
INTERNAL_SERVER_EXCEPTION— The participant failed to publish to the stage due to an internal server error. -
INVALID_AUDIO_CODEC— The participant is using an invalid audio codec. For details, see Stream Ingest. -
INVALID_INPUT— The participant is using an invalid input stream. -
INVALID_PROTOCOL— The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing. -
INVALID_STREAM_KEY— The participant is using an invalid stream key. For details, see IVS RTMP Publishing. -
INVALID_VIDEO_CODEC— The participant is using an invalid video codec. For details, see Stream Ingest. -
PUBLISHER_NOT_FOUND— The participant tried to subscribe to a publisher that doesn’t exist. -
QUOTA_EXCEEDED— The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas. -
RESOLUTION_EXCEEDED— The participant exceeded the maximum supported resolution. For details, see Service Quotas. -
REUSE_OF_STREAM_KEY— The participant tried to use a stream key that is associated with another active stage session. -
STREAM_DURATION_EXCEEDED— The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.
Sourcepub fn destination_stage_arn(self, input: impl Into<String>) -> Self
pub fn destination_stage_arn(self, input: impl Into<String>) -> Self
ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
Sourcepub fn set_destination_stage_arn(self, input: Option<String>) -> Self
pub fn set_destination_stage_arn(self, input: Option<String>) -> Self
ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
Sourcepub fn get_destination_stage_arn(&self) -> &Option<String>
pub fn get_destination_stage_arn(&self) -> &Option<String>
ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
Sourcepub fn destination_session_id(self, input: impl Into<String>) -> Self
pub fn destination_session_id(self, input: impl Into<String>) -> Self
ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
Sourcepub fn set_destination_session_id(self, input: Option<String>) -> Self
pub fn set_destination_session_id(self, input: Option<String>) -> Self
ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
Sourcepub fn get_destination_session_id(&self) -> &Option<String>
pub fn get_destination_session_id(&self) -> &Option<String>
ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
Sourcepub fn replica(self, input: bool) -> Self
pub fn replica(self, input: bool) -> Self
If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId. Default: false.
Sourcepub fn set_replica(self, input: Option<bool>) -> Self
pub fn set_replica(self, input: Option<bool>) -> Self
If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId. Default: false.
Sourcepub fn get_replica(&self) -> &Option<bool>
pub fn get_replica(&self) -> &Option<bool>
If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId. Default: false.
Trait Implementations§
Source§impl Clone for EventBuilder
impl Clone for EventBuilder
Source§fn clone(&self) -> EventBuilder
fn clone(&self) -> EventBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for EventBuilder
impl Debug for EventBuilder
Source§impl Default for EventBuilder
impl Default for EventBuilder
Source§fn default() -> EventBuilder
fn default() -> EventBuilder
Source§impl PartialEq for EventBuilder
impl PartialEq for EventBuilder
impl StructuralPartialEq for EventBuilder
Auto Trait Implementations§
impl Freeze for EventBuilder
impl RefUnwindSafe for EventBuilder
impl Send for EventBuilder
impl Sync for EventBuilder
impl Unpin for EventBuilder
impl UnwindSafe for EventBuilder
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);