Struct SpaceInviteCreateInput 

#[non_exhaustive]
pub struct SpaceInviteCreateInput<'a> {
    pub client_id: Option<&'a str>,
    pub space_id: &'a Id,
    pub default_channel_id: Option<&'a Id>,
    pub expires_at: Option<&'a UTCDate>,
    pub max_uses: Option<u64>,
}

Parameters for creating one SpaceInvite via SpaceInvite/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 invite grants access to.

default_channel_id: Option<&'a Id>

Channel that joining members land in by default. None lets the server choose.

expires_at: Option<&'a UTCDate>

Optional expiry time after which the invite is no longer redeemable.

max_uses: Option<u64>

Maximum number of times the invite may be redeemed.

Implementations

impl<'a> SpaceInviteCreateInput<'a>

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

Create a SpaceInviteCreateInput 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).

pub fn with_max_uses(self, max: u64) -> Self

Set the maximum number of times this invite may be used.

Trait Implementations

impl<'a> Clone for SpaceInviteCreateInput<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SpaceInviteCreateInput<'a>

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

Formats the value using the given formatter.