Enum Message 

pub enum Message {
    Connect {
        db_name: String,
        password: Option<Zeroizing<String>>,
        username: Option<String>,
    },
    ConnectOk {
        version: String,
    },
    Query {
        query: String,
    },
    QuerySql {
        query: String,
    },
    QueryWithParams {
        query: String,
        params: Vec<WireParam>,
    },
    SyncStatus {
        replica_id: String,
    },
    SyncPull {
        replica_id: String,
        since_lsn: u64,
        max_units: u32,
        max_bytes: u64,
        database_id: [u8; 16],
        primary_generation: u64,
        wal_format_version: u16,
        catalog_version: u16,
        segment_format_version: u16,
    },
    SyncAck {
        replica_id: String,
        applied_lsn: u64,
        remote_lsn: u64,
    },
    SyncStatusResult {
        status: WireSyncStatus,
    },
    SyncPullResult {
        status: WireSyncStatus,
        units: Vec<WireRetainedUnit>,
        has_more: bool,
    },
    SyncAckResult {
        previous_applied_lsn: u64,
        applied_lsn: u64,
        remote_lsn: u64,
        advanced: bool,
        status: WireSyncStatus,
    },
    ResultRows {
        columns: Vec<String>,
        rows: Vec<Vec<String>>,
    },
    ResultScalar {
        value: String,
    },
    ResultOk {
        affected: u64,
    },
    ResultMessage {
        message: String,
    },
    Error {
        message: String,
    },
    Disconnect,
    Ping,
    Pong,
}

Variants

Connect

Fields

db_name: String

password: Option<Zeroizing<String>>

Client-supplied candidate password. Wrapped in Zeroizing so the raw bytes from the wire are wiped from memory once the Message (and thus this field) is dropped after the constant-time compare — the candidate never lingers in a plain String.

username: Option<String>

Optional user name for multi-user authentication. Appended after the password on the wire so the format is a pure, backward-compatible extension: old clients that omit it decode as None.

ConnectOk

Fields

version: String

Query

Fields

query: String

QuerySql

A SQL query string.

Fields

query: String

QueryWithParams

A query string with positional $N parameters bound at the server.

Fields

query: String

params: Vec<WireParam>

SyncStatus

Request primary-side status for one embedded replica cursor.

Fields

replica_id: String

SyncPull

Pull a bounded retained-unit chunk after the server-side replica cursor.

Fields

replica_id: String

since_lsn: u64

max_units: u32

max_bytes: u64

database_id: [u8; 16]

primary_generation: u64

wal_format_version: u16

catalog_version: u16

segment_format_version: u16

SyncAck

Acknowledge that the replica applied retained history through applied_lsn.

Fields

replica_id: String

applied_lsn: u64

remote_lsn: u64

SyncStatusResult

Fields

status: WireSyncStatus

SyncPullResult

Fields

status: WireSyncStatus

units: Vec<WireRetainedUnit>

has_more: bool

SyncAckResult

Fields

previous_applied_lsn: u64

applied_lsn: u64

remote_lsn: u64

advanced: bool

status: WireSyncStatus

ResultRows

Fields

columns: Vec<String>

rows: Vec<Vec<String>>

ResultScalar

Fields

value: String

ResultOk

Fields

affected: u64

ResultMessage

A descriptive status message (e.g. “type User created”, “index dropped”).

Fields

message: String

Error

Fields

message: String

Disconnect

Ping

Pong

Implementations

impl Message

pub fn encode(&self) -> Vec<u8>

Encode message into wire format: [type(1)][flags(1)][len(4)][payload]

pub fn decode(data: &[u8]) -> Result<Message, String>

Decode message from wire format.

pub async fn write_to<W: AsyncWriteExt + Unpin>( &self, writer: &mut W, ) -> Result<()>

Write this message to an async writer.

pub async fn read_from<R: AsyncReadExt + Unpin>( reader: &mut R, ) -> Result<Option<Message>>

Read a message from an async reader.

pub async fn read_from_preauth<R: AsyncReadExt + Unpin>( reader: &mut R, ) -> Result<Option<Message>>

Read a pre-auth message with a smaller payload limit (4 KB). Use this before authentication is complete to prevent oversized CONNECT payloads from consuming server memory.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.