Struct UserLimitExceededErrorData 

#[non_exhaustive]
pub struct UserLimitExceededErrorData {
    pub info_uri: String,
    pub can_upgrade: bool,
}

Available on crate feature api only.

Data for the M_USER_LIMIT_EXCEEDED ErrorKind.

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.

info_uri: String

A URI that the client can present to the user to provide more context on the encountered limit and, if applicable, guidance on how to increase the limit.

The homeserver MAY return different values depending on the type of limit reached.

can_upgrade: bool

Whether the specific limit encountered can be increased.

If true, it indicates that the specific limit encountered can be increased, for example by upgrading the user’s account tier. If false, the limit is a hard limit that cannot be increased.

Defaults to false.

Implementations

impl UserLimitExceededErrorData

pub fn new(info_uri: String) -> Self

Construct a new UserLimitExceededErrorData with the given URI.

Trait Implementations

impl Clone for UserLimitExceededErrorData

fn clone(&self) -> UserLimitExceededErrorData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserLimitExceededErrorData

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

Formats the value using the given formatter.

impl PartialEq for UserLimitExceededErrorData

fn eq(&self, other: &UserLimitExceededErrorData) -> 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 Eq for UserLimitExceededErrorData

impl StructuralPartialEq for UserLimitExceededErrorData