Struct FileAttachment 

pub struct FileAttachment {
    pub id: String,
    pub name: String,
    pub content_type: String,
    pub data: Bytes,
}

Binary attachment carried alongside JSON params or event data.

In protocol v3 the attachment payload is stored as raw bytes in a binary section appended after the JSON metadata, eliminating the 33% overhead of Base64 encoding used in protocol v1.

The payload uses Bytes (reference-counted, immutable) so that cloning an attachment — e.g. during ECDH broadcasts — is a cheap refcount bump rather than a deep copy of the entire buffer.

Fields

id: String

Attachment identifier referenced from JSON using { "$file": "..." }.

name: String

Original file name.

content_type: String

MIME type supplied by the sender.

data: Bytes

Raw attachment payload bytes (zero-copy shared via Bytes).

Implementations

impl FileAttachment

pub fn inline_text( id: impl Into<String>, name: impl Into<String>, content_type: impl Into<String>, text: impl AsRef<str>, ) -> Self

Builds a text attachment from a string.

pub fn inline_bytes( id: impl Into<String>, name: impl Into<String>, content_type: impl Into<String>, bytes: impl Into<Bytes>, ) -> Self

Builds a binary attachment from raw bytes.

Accepts anything convertible into Bytes (Vec<u8>, Bytes, &'static [u8], etc.).

pub fn size(&self) -> usize

Returns the byte length of the attachment payload.

pub fn param_ref(id: impl Into<String>) -> Value

Returns a JSON reference object that points to an attachment by id.

Trait Implementations

impl Clone for FileAttachment

fn clone(&self) -> FileAttachment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileAttachment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileAttachment

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

Deserialize this value from the given Serde deserializer.

impl Serialize for FileAttachment

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

Serialize this value into the given Serde serializer.