#[non_exhaustive]pub struct CreateChannelInput {Show 13 fields
pub app_instance_arn: Option<String>,
pub name: Option<String>,
pub mode: Option<ChannelMode>,
pub privacy: Option<ChannelPrivacy>,
pub metadata: Option<String>,
pub client_request_token: Option<String>,
pub tags: Option<Vec<Tag>>,
pub chime_bearer: Option<String>,
pub channel_id: Option<String>,
pub member_arns: Option<Vec<String>>,
pub moderator_arns: Option<Vec<String>>,
pub elastic_channel_configuration: Option<ElasticChannelConfiguration>,
pub expiration_settings: Option<ExpirationSettings>,
}
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.app_instance_arn: Option<String>
The ARN of the channel request.
name: Option<String>
The name of the channel.
mode: Option<ChannelMode>
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
privacy: Option<ChannelPrivacy>
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
metadata: Option<String>
The metadata of the creation request. Limited to 1KB and UTF-8.
client_request_token: Option<String>
The client token for the request. An Idempotency
token.
The tags for the creation request.
chime_bearer: Option<String>
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.
channel_id: Option<String>
An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.
member_arns: Option<Vec<String>>
The ARNs of the channel members in the request.
moderator_arns: Option<Vec<String>>
The ARNs of the channel moderators in the request.
elastic_channel_configuration: Option<ElasticChannelConfiguration>
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
expiration_settings: Option<ExpirationSettings>
Settings that control the interval after which the channel is automatically deleted.
Implementations§
Source§impl CreateChannelInput
impl CreateChannelInput
Sourcepub fn app_instance_arn(&self) -> Option<&str>
pub fn app_instance_arn(&self) -> Option<&str>
The ARN of the channel request.
Sourcepub fn mode(&self) -> Option<&ChannelMode>
pub fn mode(&self) -> Option<&ChannelMode>
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
Sourcepub fn privacy(&self) -> Option<&ChannelPrivacy>
pub fn privacy(&self) -> Option<&ChannelPrivacy>
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
Sourcepub fn metadata(&self) -> Option<&str>
pub fn metadata(&self) -> Option<&str>
The metadata of the creation request. Limited to 1KB and UTF-8.
Sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
The client token for the request. An Idempotency
token.
The tags for the creation request.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn chime_bearer(&self) -> Option<&str>
pub fn chime_bearer(&self) -> Option<&str>
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.
Sourcepub fn channel_id(&self) -> Option<&str>
pub fn channel_id(&self) -> Option<&str>
An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.
Sourcepub fn member_arns(&self) -> &[String]
pub fn member_arns(&self) -> &[String]
The ARNs of the channel members in the request.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .member_arns.is_none()
.
Sourcepub fn moderator_arns(&self) -> &[String]
pub fn moderator_arns(&self) -> &[String]
The ARNs of the channel moderators in the request.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .moderator_arns.is_none()
.
Sourcepub fn elastic_channel_configuration(
&self,
) -> Option<&ElasticChannelConfiguration>
pub fn elastic_channel_configuration( &self, ) -> Option<&ElasticChannelConfiguration>
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
Sourcepub fn expiration_settings(&self) -> Option<&ExpirationSettings>
pub fn expiration_settings(&self) -> Option<&ExpirationSettings>
Settings that control the interval after which the channel is automatically deleted.
Source§impl CreateChannelInput
impl CreateChannelInput
Sourcepub fn builder() -> CreateChannelInputBuilder
pub fn builder() -> CreateChannelInputBuilder
Creates a new builder-style object to manufacture CreateChannelInput
.
Trait Implementations§
Source§impl Clone for CreateChannelInput
impl Clone for CreateChannelInput
Source§fn clone(&self) -> CreateChannelInput
fn clone(&self) -> CreateChannelInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateChannelInput
impl Debug for CreateChannelInput
Source§impl PartialEq for CreateChannelInput
impl PartialEq for CreateChannelInput
impl StructuralPartialEq for CreateChannelInput
Auto Trait Implementations§
impl Freeze for CreateChannelInput
impl RefUnwindSafe for CreateChannelInput
impl Send for CreateChannelInput
impl Sync for CreateChannelInput
impl Unpin for CreateChannelInput
impl UnwindSafe for CreateChannelInput
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);