#[non_exhaustive]pub struct Participant {Show 20 fields
pub participant_id: Option<String>,
pub user_id: Option<String>,
pub state: Option<ParticipantState>,
pub first_join_time: Option<DateTime>,
pub attributes: Option<HashMap<String, String>>,
pub published: bool,
pub isp_name: Option<String>,
pub os_name: Option<String>,
pub os_version: Option<String>,
pub browser_name: Option<String>,
pub browser_version: Option<String>,
pub sdk_version: Option<String>,
pub recording_s3_bucket_name: Option<String>,
pub recording_s3_prefix: Option<String>,
pub recording_state: Option<ParticipantRecordingState>,
pub protocol: Option<ParticipantProtocol>,
pub replication_type: Option<ReplicationType>,
pub replication_state: Option<ReplicationState>,
pub source_stage_arn: Option<String>,
pub source_session_id: Option<String>,
}Expand description
Object describing a participant that has joined a stage.
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.participant_id: Option<String>Unique identifier for this participant, assigned by IVS.
user_id: Option<String>Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
state: Option<ParticipantState>Whether the participant is connected to or disconnected from the stage.
first_join_time: Option<DateTime>ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
attributes: Option<HashMap<String, String>>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
published: boolWhether the participant ever published to the stage session.
isp_name: Option<String>The participant’s Internet Service Provider.
os_name: Option<String>The participant’s operating system.
os_version: Option<String>The participant’s operating system version.
browser_name: Option<String>The participant’s browser.
browser_version: Option<String>The participant’s browser version.
sdk_version: Option<String>The participant’s SDK version.
recording_s3_bucket_name: Option<String>Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
recording_s3_prefix: Option<String>S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See Merge Fragmented Individual Participant Recordings.
recording_state: Option<ParticipantRecordingState>The participant’s recording state.
protocol: Option<ParticipantProtocol>Type of ingest protocol that the participant employs for broadcasting.
replication_type: Option<ReplicationType>Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
replication_state: Option<ReplicationState>The participant's replication state.
source_stage_arn: Option<String>Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
source_session_id: Option<String>ID of the session within the source stage, if replicationType is REPLICA.
Implementations§
Source§impl Participant
impl Participant
Sourcepub fn participant_id(&self) -> Option<&str>
pub fn participant_id(&self) -> Option<&str>
Unique identifier for this participant, assigned by IVS.
Sourcepub fn user_id(&self) -> Option<&str>
pub fn user_id(&self) -> Option<&str>
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Sourcepub fn state(&self) -> Option<&ParticipantState>
pub fn state(&self) -> Option<&ParticipantState>
Whether the participant is connected to or disconnected from the stage.
Sourcepub fn first_join_time(&self) -> Option<&DateTime>
pub fn first_join_time(&self) -> Option<&DateTime>
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
Sourcepub fn attributes(&self) -> Option<&HashMap<String, String>>
pub fn attributes(&self) -> Option<&HashMap<String, String>>
Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Sourcepub fn os_version(&self) -> Option<&str>
pub fn os_version(&self) -> Option<&str>
The participant’s operating system version.
Sourcepub fn browser_name(&self) -> Option<&str>
pub fn browser_name(&self) -> Option<&str>
The participant’s browser.
Sourcepub fn browser_version(&self) -> Option<&str>
pub fn browser_version(&self) -> Option<&str>
The participant’s browser version.
Sourcepub fn sdk_version(&self) -> Option<&str>
pub fn sdk_version(&self) -> Option<&str>
The participant’s SDK version.
Sourcepub fn recording_s3_bucket_name(&self) -> Option<&str>
pub fn recording_s3_bucket_name(&self) -> Option<&str>
Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
Sourcepub fn recording_s3_prefix(&self) -> Option<&str>
pub fn recording_s3_prefix(&self) -> Option<&str>
S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See Merge Fragmented Individual Participant Recordings.
Sourcepub fn recording_state(&self) -> Option<&ParticipantRecordingState>
pub fn recording_state(&self) -> Option<&ParticipantRecordingState>
The participant’s recording state.
Sourcepub fn protocol(&self) -> Option<&ParticipantProtocol>
pub fn protocol(&self) -> Option<&ParticipantProtocol>
Type of ingest protocol that the participant employs for broadcasting.
Sourcepub fn replication_type(&self) -> Option<&ReplicationType>
pub fn replication_type(&self) -> Option<&ReplicationType>
Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
Sourcepub fn replication_state(&self) -> Option<&ReplicationState>
pub fn replication_state(&self) -> Option<&ReplicationState>
The participant's replication state.
Sourcepub fn source_stage_arn(&self) -> Option<&str>
pub fn source_stage_arn(&self) -> Option<&str>
Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
Sourcepub fn source_session_id(&self) -> Option<&str>
pub fn source_session_id(&self) -> Option<&str>
ID of the session within the source stage, if replicationType is REPLICA.
Source§impl Participant
impl Participant
Sourcepub fn builder() -> ParticipantBuilder
pub fn builder() -> ParticipantBuilder
Creates a new builder-style object to manufacture Participant.
Trait Implementations§
Source§impl Clone for Participant
impl Clone for Participant
Source§fn clone(&self) -> Participant
fn clone(&self) -> Participant
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for Participant
impl Debug for Participant
Source§impl PartialEq for Participant
impl PartialEq for Participant
impl StructuralPartialEq for Participant
Auto Trait Implementations§
impl Freeze for Participant
impl RefUnwindSafe for Participant
impl Send for Participant
impl Sync for Participant
impl Unpin for Participant
impl UnwindSafe for Participant
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);