Skip to main content

InvitePayload

Struct InvitePayload 

Source
pub struct InvitePayload {
    pub room_owner_vk: VerifyingKey,
    pub invitation_payload: Vec<u8>,
    pub personal_message: Option<String>,
}
Expand description

Inner shape of DirectMessageBody::Invite.

invitation_payload is the CBOR-encoded ui::components::members::Invitation (the same bytes that get base58-encoded as the ?invitation=… URL parameter). Encoding it as CBOR bytes here (rather than the base58 string form) saves the encode-decode round-trip on the recipient side and keeps the wire body smaller — base58 is a 1.37x expansion.

room_owner_vk redundantly carries the target room’s owner key so a client can show a “you’re invited to room X” affordance without first round-tripping the payload through Invitation decode. It MUST match what the payload’s invitation deserialises to; the recipient SHOULD reject mismatches as malformed.

Fields§

§room_owner_vk: VerifyingKey

Owner verifying-key of the target room. Cheap to inspect without decoding invitation_payload.

§invitation_payload: Vec<u8>

CBOR-encoded Invitation (room + invitee signing key + authorised member). Same bytes that would otherwise be base58-encoded as the ?invitation=… URL parameter.

§personal_message: Option<String>

Optional sender-typed message rendered above the Accept button. None means “no extra text”; the recipient SHOULD hide the message box entirely in that case rather than rendering an empty line.

Trait Implementations§

Source§

impl Clone for InvitePayload

Source§

fn clone(&self) -> InvitePayload

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InvitePayload

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for InvitePayload

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for InvitePayload

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for InvitePayload

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for InvitePayload

Source§

impl StructuralPartialEq for InvitePayload

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,