Skip to main content

RoomMessageBody

Enum RoomMessageBody 

Source
pub enum RoomMessageBody {
    Public {
        content_type: u32,
        content_version: u32,
        data: Vec<u8>,
    },
    Private {
        content_type: u32,
        content_version: u32,
        ciphertext: Vec<u8>,
        nonce: [u8; 12],
        secret_version: SecretVersion,
    },
}
Expand description

Message body that can be either public or private (encrypted).

Content is opaque to the contract - interpretation happens client-side. This design enables adding new content types without contract redeployment.

§Content Types

  • content_type = 1: Text message (TextContentV1)
  • content_type = 2: Action on another message (ActionContentV1)
  • Future types can be added without contract changes

§Extensibility

  • New content types: Just use a new content_type number
  • New action types: Just use a new action_type number within ActionContentV1
  • New fields: Add to content structs (old clients ignore unknown fields)
  • Breaking changes: Bump content_version

Variants§

§

Public

Public (unencrypted) message

Fields

§content_type: u32

Content type identifier (see content module for constants)

§content_version: u32

Version of the content format

§data: Vec<u8>

CBOR-encoded content bytes

§

Private

Private (encrypted) message

Fields

§content_type: u32

Content type identifier (see content module for constants)

§content_version: u32

Version of the content format

§ciphertext: Vec<u8>

Encrypted CBOR-encoded content

§nonce: [u8; 12]

Nonce used for encryption

§secret_version: SecretVersion

Version of the room secret used for encryption

Implementations§

Source§

impl RoomMessageBody

Source

pub fn public(text: String) -> Self

Create a new public text message

Source

pub fn public_raw( content_type: u32, content_version: u32, data: Vec<u8>, ) -> Self

Create a new public message with raw content

Source

pub fn private( content_type: u32, content_version: u32, ciphertext: Vec<u8>, nonce: [u8; 12], secret_version: SecretVersion, ) -> Self

Create a new private message

Source

pub fn private_text( ciphertext: Vec<u8>, nonce: [u8; 12], secret_version: SecretVersion, ) -> Self

Create a private text message (convenience method)

Source

pub fn edit(target: MessageId, new_text: String) -> Self

Create an edit action (public)

Source

pub fn delete(target: MessageId) -> Self

Create a delete action (public)

Source

pub fn reaction(target: MessageId, emoji: String) -> Self

Create a reaction action (public)

Source

pub fn remove_reaction(target: MessageId, emoji: String) -> Self

Create a remove reaction action (public)

Source

pub fn private_action( ciphertext: Vec<u8>, nonce: [u8; 12], secret_version: SecretVersion, ) -> Self

Create a private action message (encrypted)

Use this for any action (edit, delete, reaction, remove_reaction) in a private room. The caller should:

  1. Create the ActionContentV1 (e.g., ActionContentV1::edit(target, new_text))
  2. Encode it: action.encode()
  3. Encrypt the bytes with the room secret
  4. Pass the ciphertext here
Source

pub fn is_public(&self) -> bool

Check if this is a public message

Source

pub fn is_private(&self) -> bool

Check if this is a private message

Source

pub fn content_type(&self) -> u32

Get the content type

Source

pub fn content_version(&self) -> u32

Get the content version

Source

pub fn is_action(&self) -> bool

Check if this is an action message (content_type = ACTION)

Source

pub fn decode_content(&self) -> Option<DecodedContent>

Decode the content (for public messages only) Returns None for private messages - decrypt first

Source

pub fn target_id(&self) -> Option<MessageId>

Get the target message ID if this is an action

Source

pub fn content_len(&self) -> usize

Get the content length for validation (contract uses this for size limits)

Source

pub fn secret_version(&self) -> Option<SecretVersion>

Get the secret version (if private)

Source

pub fn to_string_lossy(&self) -> String

Get a string representation for display purposes

Source

pub fn as_public_string(&self) -> Option<String>

Try to get the public plaintext, returns None if private or not a text message

Trait Implementations§

Source§

impl Clone for RoomMessageBody

Source§

fn clone(&self) -> RoomMessageBody

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RoomMessageBody

Source§

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

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

impl<'de> Deserialize<'de> for RoomMessageBody

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 Display for RoomMessageBody

Source§

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

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

impl PartialEq for RoomMessageBody

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 RoomMessageBody

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 StructuralPartialEq for RoomMessageBody

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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>,