Struct UserSetting

#[non_exhaustive]
pub struct UserSetting {
    pub action: Option<Action>,
    pub permission: Option<Permission>,
    pub maximum_length: Option<i32>,
}

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

action: Option<Action>

The action that is enabled or disabled.

permission: Option<Permission>

Indicates whether the action is enabled or disabled.

maximum_length: Option<i32>

Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.

The value can be between 1 and 20,971,520 (20 MB).

Implementations

impl UserSetting

pub fn action(&self) -> Option<&Action>

The action that is enabled or disabled.

pub fn permission(&self) -> Option<&Permission>

Indicates whether the action is enabled or disabled.

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

Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.

The value can be between 1 and 20,971,520 (20 MB).

impl UserSetting

pub fn builder() -> UserSettingBuilder

Creates a new builder-style object to manufacture UserSetting.

Trait Implementations

impl Clone for UserSetting

fn clone(&self) -> UserSetting

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserSetting

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

Formats the value using the given formatter.

impl PartialEq for UserSetting

fn eq(&self, other: &UserSetting) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserSetting