Struct SpaceBanCreateInput 

#[non_exhaustive]
pub struct SpaceBanCreateInput<'a> {
    pub client_id: Option<&'a str>,
    pub space_id: &'a Id,
    pub user_id: &'a Id,
    pub reason: Option<&'a str>,
    pub expires_at: Option<&'a UTCDate>,
}

Parameters for creating one SpaceBan via SpaceBan/set.

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.

client_id: Option<&'a str>

Caller-supplied creation key. When None — or Some("") — a ULID is generated automatically. An empty Some("") is treated the same as None, not as a rejection; callers must not assume the wire echoes a caller-supplied empty string.

space_id: &'a Id

The Space this ban applies to.

user_id: &'a Id

ChatContact.id of the user to ban.

reason: Option<&'a str>

Optional human-readable reason for the ban.

expires_at: Option<&'a UTCDate>

Optional expiry time after which the ban is automatically lifted.

Implementations

impl<'a> SpaceBanCreateInput<'a>

pub fn new(space_id: &'a Id, user_id: &'a Id) -> Self

Create a SpaceBanCreateInput with required fields; optional fields default to None.

pub fn with_client_id(self, id: &'a str) -> Self

Set the caller-supplied creation key (overrides the auto-generated ULID).

Trait Implementations

impl<'a> Clone for SpaceBanCreateInput<'a>

fn clone(&self) -> SpaceBanCreateInput<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SpaceBanCreateInput<'a>

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

Formats the value using the given formatter.