Enum FrontendMessage 

pub enum FrontendMessage {
    Startup {
        protocol_version: i32,
        params: HashMap<String, String>,
    },
    Password {
        password: String,
    },
    Query {
        query: String,
    },
    Terminate,
    SSLRequest,
    Subscribe {
        query: String,
        params: Vec<Option<Vec<u8>>>,
        filter: Option<String>,
        selective_updates_config: Option<SelectiveUpdatesConfig>,
    },
    Unsubscribe {
        subscription_id: [u8; 16],
    },
    SubscriptionPause {
        subscription_id: [u8; 16],
    },
    SubscriptionResume {
        subscription_id: [u8; 16],
    },
}

Frontend message types (client -> server)

Variants

Startup

Startup message

Fields

protocol_version: i32

params: HashMap<String, String>

Password

Password message

Fields

password: String

Query

Query message

Fields

query: String

Terminate

Terminate message

SSLRequest

SSL request

Subscribe

Subscribe message (0xF0) - subscribe to query The optional filter is a SQL WHERE clause expression applied to subscription updates. The optional selective_updates_config allows clients to override server-level selective update settings.

Fields

query: String

params: Vec<Option<Vec<u8>>>

filter: Option<String>

selective_updates_config: Option<SelectiveUpdatesConfig>

Unsubscribe

Unsubscribe message (0xF1) - cancel subscription

Fields

subscription_id: [u8; 16]

SubscriptionPause

Pause subscription message (0xF5) - temporarily pause updates

Fields

subscription_id: [u8; 16]

SubscriptionResume

Resume subscription message (0xF6) - resume paused subscription

Fields

subscription_id: [u8; 16]

Implementations

impl FrontendMessage

pub fn decode(buf: &mut BytesMut) -> Result<Option<Self>, ProtocolError>

Decode a frontend message from bytes

pub fn decode_startup(buf: &mut BytesMut) -> Result<Option<Self>, ProtocolError>

Decode startup message (special case - no message type byte)

Trait Implementations

impl Clone for FrontendMessage

fn clone(&self) -> FrontendMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrontendMessage

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

Formats the value using the given formatter.

impl PartialEq for FrontendMessage

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