#[non_exhaustive]pub struct ParticipantBuilder { /* private fields */ }Expand description
A builder for Participant.
Implementations§
Source§impl ParticipantBuilder
impl ParticipantBuilder
Sourcepub fn participant_id(self, input: impl Into<String>) -> Self
pub fn participant_id(self, input: impl Into<String>) -> Self
Unique identifier for this participant, 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 this participant, assigned by IVS.
Sourcepub fn get_participant_id(&self) -> &Option<String>
pub fn get_participant_id(&self) -> &Option<String>
Unique identifier for this participant, assigned by IVS.
Sourcepub fn user_id(self, input: impl Into<String>) -> Self
pub fn user_id(self, input: impl Into<String>) -> Self
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 set_user_id(self, input: Option<String>) -> Self
pub fn set_user_id(self, input: Option<String>) -> Self
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 get_user_id(&self) -> &Option<String>
pub fn get_user_id(&self) -> &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.
Sourcepub fn state(self, input: ParticipantState) -> Self
pub fn state(self, input: ParticipantState) -> Self
Whether the participant is connected to or disconnected from the stage.
Sourcepub fn set_state(self, input: Option<ParticipantState>) -> Self
pub fn set_state(self, input: Option<ParticipantState>) -> Self
Whether the participant is connected to or disconnected from the stage.
Sourcepub fn get_state(&self) -> &Option<ParticipantState>
pub fn get_state(&self) -> &Option<ParticipantState>
Whether the participant is connected to or disconnected from the stage.
Sourcepub fn first_join_time(self, input: DateTime) -> Self
pub fn first_join_time(self, input: DateTime) -> Self
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
Sourcepub fn set_first_join_time(self, input: Option<DateTime>) -> Self
pub fn set_first_join_time(self, input: Option<DateTime>) -> Self
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
Sourcepub fn get_first_join_time(&self) -> &Option<DateTime>
pub fn get_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, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to attributes.
To override the contents of this collection use set_attributes.
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 set_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
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 get_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_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 published(self, input: bool) -> Self
pub fn published(self, input: bool) -> Self
Whether the participant ever published to the stage session.
Sourcepub fn set_published(self, input: Option<bool>) -> Self
pub fn set_published(self, input: Option<bool>) -> Self
Whether the participant ever published to the stage session.
Sourcepub fn get_published(&self) -> &Option<bool>
pub fn get_published(&self) -> &Option<bool>
Whether the participant ever published to the stage session.
Sourcepub fn isp_name(self, input: impl Into<String>) -> Self
pub fn isp_name(self, input: impl Into<String>) -> Self
The participant’s Internet Service Provider.
Sourcepub fn set_isp_name(self, input: Option<String>) -> Self
pub fn set_isp_name(self, input: Option<String>) -> Self
The participant’s Internet Service Provider.
Sourcepub fn get_isp_name(&self) -> &Option<String>
pub fn get_isp_name(&self) -> &Option<String>
The participant’s Internet Service Provider.
Sourcepub fn set_os_name(self, input: Option<String>) -> Self
pub fn set_os_name(self, input: Option<String>) -> Self
The participant’s operating system.
Sourcepub fn get_os_name(&self) -> &Option<String>
pub fn get_os_name(&self) -> &Option<String>
The participant’s operating system.
Sourcepub fn os_version(self, input: impl Into<String>) -> Self
pub fn os_version(self, input: impl Into<String>) -> Self
The participant’s operating system version.
Sourcepub fn set_os_version(self, input: Option<String>) -> Self
pub fn set_os_version(self, input: Option<String>) -> Self
The participant’s operating system version.
Sourcepub fn get_os_version(&self) -> &Option<String>
pub fn get_os_version(&self) -> &Option<String>
The participant’s operating system version.
Sourcepub fn browser_name(self, input: impl Into<String>) -> Self
pub fn browser_name(self, input: impl Into<String>) -> Self
The participant’s browser.
Sourcepub fn set_browser_name(self, input: Option<String>) -> Self
pub fn set_browser_name(self, input: Option<String>) -> Self
The participant’s browser.
Sourcepub fn get_browser_name(&self) -> &Option<String>
pub fn get_browser_name(&self) -> &Option<String>
The participant’s browser.
Sourcepub fn browser_version(self, input: impl Into<String>) -> Self
pub fn browser_version(self, input: impl Into<String>) -> Self
The participant’s browser version.
Sourcepub fn set_browser_version(self, input: Option<String>) -> Self
pub fn set_browser_version(self, input: Option<String>) -> Self
The participant’s browser version.
Sourcepub fn get_browser_version(&self) -> &Option<String>
pub fn get_browser_version(&self) -> &Option<String>
The participant’s browser version.
Sourcepub fn sdk_version(self, input: impl Into<String>) -> Self
pub fn sdk_version(self, input: impl Into<String>) -> Self
The participant’s SDK version.
Sourcepub fn set_sdk_version(self, input: Option<String>) -> Self
pub fn set_sdk_version(self, input: Option<String>) -> Self
The participant’s SDK version.
Sourcepub fn get_sdk_version(&self) -> &Option<String>
pub fn get_sdk_version(&self) -> &Option<String>
The participant’s SDK version.
Sourcepub fn recording_s3_bucket_name(self, input: impl Into<String>) -> Self
pub fn recording_s3_bucket_name(self, input: impl Into<String>) -> Self
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 set_recording_s3_bucket_name(self, input: Option<String>) -> Self
pub fn set_recording_s3_bucket_name(self, input: Option<String>) -> Self
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 get_recording_s3_bucket_name(&self) -> &Option<String>
pub fn get_recording_s3_bucket_name(&self) -> &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.
Sourcepub fn recording_s3_prefix(self, input: impl Into<String>) -> Self
pub fn recording_s3_prefix(self, input: impl Into<String>) -> Self
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 set_recording_s3_prefix(self, input: Option<String>) -> Self
pub fn set_recording_s3_prefix(self, input: Option<String>) -> Self
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 get_recording_s3_prefix(&self) -> &Option<String>
pub fn get_recording_s3_prefix(&self) -> &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.
Sourcepub fn recording_state(self, input: ParticipantRecordingState) -> Self
pub fn recording_state(self, input: ParticipantRecordingState) -> Self
The participant’s recording state.
Sourcepub fn set_recording_state(
self,
input: Option<ParticipantRecordingState>,
) -> Self
pub fn set_recording_state( self, input: Option<ParticipantRecordingState>, ) -> Self
The participant’s recording state.
Sourcepub fn get_recording_state(&self) -> &Option<ParticipantRecordingState>
pub fn get_recording_state(&self) -> &Option<ParticipantRecordingState>
The participant’s recording state.
Sourcepub fn protocol(self, input: ParticipantProtocol) -> Self
pub fn protocol(self, input: ParticipantProtocol) -> Self
Type of ingest protocol that the participant employs for broadcasting.
Sourcepub fn set_protocol(self, input: Option<ParticipantProtocol>) -> Self
pub fn set_protocol(self, input: Option<ParticipantProtocol>) -> Self
Type of ingest protocol that the participant employs for broadcasting.
Sourcepub fn get_protocol(&self) -> &Option<ParticipantProtocol>
pub fn get_protocol(&self) -> &Option<ParticipantProtocol>
Type of ingest protocol that the participant employs for broadcasting.
Sourcepub fn replication_type(self, input: ReplicationType) -> Self
pub fn replication_type(self, input: ReplicationType) -> Self
Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
Sourcepub fn set_replication_type(self, input: Option<ReplicationType>) -> Self
pub fn set_replication_type(self, input: Option<ReplicationType>) -> Self
Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
Sourcepub fn get_replication_type(&self) -> &Option<ReplicationType>
pub fn get_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, input: ReplicationState) -> Self
pub fn replication_state(self, input: ReplicationState) -> Self
The participant's replication state.
Sourcepub fn set_replication_state(self, input: Option<ReplicationState>) -> Self
pub fn set_replication_state(self, input: Option<ReplicationState>) -> Self
The participant's replication state.
Sourcepub fn get_replication_state(&self) -> &Option<ReplicationState>
pub fn get_replication_state(&self) -> &Option<ReplicationState>
The participant's replication state.
Sourcepub fn source_stage_arn(self, input: impl Into<String>) -> Self
pub fn source_stage_arn(self, input: impl Into<String>) -> Self
Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
Sourcepub fn set_source_stage_arn(self, input: Option<String>) -> Self
pub fn set_source_stage_arn(self, input: Option<String>) -> Self
Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
Sourcepub fn get_source_stage_arn(&self) -> &Option<String>
pub fn get_source_stage_arn(&self) -> &Option<String>
Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
Sourcepub fn source_session_id(self, input: impl Into<String>) -> Self
pub fn source_session_id(self, input: impl Into<String>) -> Self
ID of the session within the source stage, if replicationType is REPLICA.
Sourcepub fn set_source_session_id(self, input: Option<String>) -> Self
pub fn set_source_session_id(self, input: Option<String>) -> Self
ID of the session within the source stage, if replicationType is REPLICA.
Sourcepub fn get_source_session_id(&self) -> &Option<String>
pub fn get_source_session_id(&self) -> &Option<String>
ID of the session within the source stage, if replicationType is REPLICA.
Sourcepub fn build(self) -> Participant
pub fn build(self) -> Participant
Consumes the builder and constructs a Participant.
Trait Implementations§
Source§impl Clone for ParticipantBuilder
impl Clone for ParticipantBuilder
Source§fn clone(&self) -> ParticipantBuilder
fn clone(&self) -> ParticipantBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ParticipantBuilder
impl Debug for ParticipantBuilder
Source§impl Default for ParticipantBuilder
impl Default for ParticipantBuilder
Source§fn default() -> ParticipantBuilder
fn default() -> ParticipantBuilder
Source§impl PartialEq for ParticipantBuilder
impl PartialEq for ParticipantBuilder
impl StructuralPartialEq for ParticipantBuilder
Auto Trait Implementations§
impl Freeze for ParticipantBuilder
impl RefUnwindSafe for ParticipantBuilder
impl Send for ParticipantBuilder
impl Sync for ParticipantBuilder
impl Unpin for ParticipantBuilder
impl UnwindSafe for ParticipantBuilder
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);