Struct ExternalInvitePayloadV1 

pub struct ExternalInvitePayloadV1 {
    pub service_pointer: Vec<u8>,
    pub external_group_id: Vec<u8>,
    pub symmetric_key: Vec<u8>,
}

v1 shape of the shareable invite blob for QR-code or link-based joining of an XMTP group via an MLS external commit.

Fields

service_pointer: Vec<u8>

Application-defined opaque bytes identifying the service location.

external_group_id: Vec<u8>

Identifier for the service slot holding the encrypted blob. Format is application-defined (UUID, snowflake, short slot key, etc.) and opaque to libxmtp; the only constraint is that the value is unique within the chosen service. Decoupled from the MLS group_id — rotation may keep this stable (overwrite the same slot) or change it (new slot on the service); the admin chooses per invite.

MUST be at least 4 bytes (collision-avoidance floor for tiny services). RECOMMENDED: 16 random bytes when no application- specific scheme is in use. Maximum length is not capped by the protocol; applications should bound it to fit their QR / link transport.

After joining, the joiner verifies this matches EXTERNAL_COMMIT_POLICY.external_group_id in the group state as defense-in-depth against a stale or swapped QR.

symmetric_key: Vec<u8>

32 bytes; ChaCha20Poly1305 key used to wrap the GroupInfo. Matches EXTERNAL_COMMIT_POLICY.symmetric_key in the group state.

Trait Implementations

impl Clone for ExternalInvitePayloadV1

fn clone(&self) -> ExternalInvitePayloadV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalInvitePayloadV1

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

Formats the value using the given formatter.

impl Default for ExternalInvitePayloadV1

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExternalInvitePayloadV1

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ExternalInvitePayloadV1

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for ExternalInvitePayloadV1

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for ExternalInvitePayloadV1

const NAME: &'static str = "ExternalInvitePayloadV1"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "xmtp.mls.message_contents"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for ExternalInvitePayloadV1

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ExternalInvitePayloadV1

impl StructuralPartialEq for ExternalInvitePayloadV1