Enum ProtocolMessage 

pub enum ProtocolMessage {
    JoinRequest {
        crdt: CrdtType,
        room_id: String,
        auth: Vec<u8>,
        version: Vec<u8>,
    },
    JoinResponseOk {
        crdt: CrdtType,
        room_id: String,
        permission: Permission,
        version: Vec<u8>,
        extra: Option<Vec<u8>>,
    },
    JoinError {
        crdt: CrdtType,
        room_id: String,
        code: JoinErrorCode,
        message: String,
        receiver_version: Option<Vec<u8>>,
        app_code: Option<String>,
    },
    DocUpdate {
        crdt: CrdtType,
        room_id: String,
        updates: Vec<Vec<u8>>,
    },
    DocUpdateFragmentHeader {
        crdt: CrdtType,
        room_id: String,
        batch_id: BatchId,
        fragment_count: u64,
        total_size_bytes: u64,
    },
    DocUpdateFragment {
        crdt: CrdtType,
        room_id: String,
        batch_id: BatchId,
        index: u64,
        fragment: Vec<u8>,
    },
    UpdateError {
        crdt: CrdtType,
        room_id: String,
        code: UpdateErrorCode,
        message: String,
        batch_id: Option<BatchId>,
        app_code: Option<String>,
    },
    Leave {
        crdt: CrdtType,
        room_id: String,
    },
}

All protocol messages as a single enum. Each variant includes the common crdt magic and room_id as part of the struct fields.

Variants

JoinRequest

Fields

crdt: CrdtType

room_id: String

auth: Vec<u8>

version: Vec<u8>

JoinResponseOk

Fields

crdt: CrdtType

room_id: String

permission: Permission

version: Vec<u8>

extra: Option<Vec<u8>>

JoinError

Fields

crdt: CrdtType

room_id: String

code: JoinErrorCode

message: String

receiver_version: Option<Vec<u8>>

app_code: Option<String>

DocUpdate

Fields

crdt: CrdtType

room_id: String

updates: Vec<Vec<u8>>

DocUpdateFragmentHeader

Fields

crdt: CrdtType

room_id: String

batch_id: BatchId

fragment_count: u64

total_size_bytes: u64

DocUpdateFragment

Fields

crdt: CrdtType

room_id: String

batch_id: BatchId

index: u64

fragment: Vec<u8>

UpdateError

Fields

crdt: CrdtType

room_id: String

code: UpdateErrorCode

message: String

batch_id: Option<BatchId>

app_code: Option<String>

Leave

Fields

crdt: CrdtType

room_id: String

Trait Implementations

impl Clone for ProtocolMessage

fn clone(&self) -> ProtocolMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolMessage

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

Formats the value using the given formatter.

impl PartialEq for ProtocolMessage

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

impl StructuralPartialEq for ProtocolMessage