Skip to main content

SpaceJoinInput

Enum SpaceJoinInput 

Source
#[non_exhaustive]
pub enum SpaceJoinInput<'a> { InviteCode(&'a str), SpaceId(&'a Id), }
Expand description

How to join a Space — passed to Space/join.

The enum makes invalid inputs unrepresentable: exactly one path is always selected at construction time.

§Debug redaction

The InviteCode variant wraps the unguessable bearer credential from draft-atwood-jmap-chat-00 §4.18 — anyone with the code can redeem it to join the Space. The Debug impl on this enum redacts the inner string to "[REDACTED]" so an accidental {:?}-format in an application log, tracing span, or test fixture cannot leak it. The SpaceId variant is not a secret (RFC 8620 §1.2) and is rendered verbatim.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

InviteCode(&'a str)

Redeem a SpaceInvite by its code field (not its id).

Unguessable secret — redacted by the std::fmt::Debug impl on this enum.

Precondition: must be non-empty. Self::space_join rejects an empty value client-side with ClientError::InvalidArgument.

§

SpaceId(&'a Id)

Join a public Space directly by its JMAP id.

Precondition: must be a non-empty Id. Id::from is the lenient constructor and accepts any string including ""; Id::new_validated is the strict one. An empty Id forwards to the server unchanged, which rejects it with invalidArguments. Construct Ids via the validating path when the value comes from untrusted input.

Trait Implementations§

Source§

impl<'a> Debug for SpaceJoinInput<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for SpaceJoinInput<'a>

§

impl<'a> RefUnwindSafe for SpaceJoinInput<'a>

§

impl<'a> Send for SpaceJoinInput<'a>

§

impl<'a> Sync for SpaceJoinInput<'a>

§

impl<'a> Unpin for SpaceJoinInput<'a>

§

impl<'a> UnsafeUnpin for SpaceJoinInput<'a>

§

impl<'a> UnwindSafe for SpaceJoinInput<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more