Skip to main content

FrontendMessage

Enum FrontendMessage 

Source
pub enum FrontendMessage {
    Startup {
        user: String,
        database: String,
    },
    PasswordMessage(String),
    Query(String),
    Parse {
        name: String,
        query: String,
        param_types: Vec<u32>,
    },
    Bind {
        portal: String,
        statement: String,
        params: Vec<Option<Vec<u8>>>,
    },
    Execute {
        portal: String,
        max_rows: i32,
    },
    Sync,
    Terminate,
    SASLInitialResponse {
        mechanism: String,
        data: Vec<u8>,
    },
    SASLResponse(Vec<u8>),
    CopyFail(String),
    Close {
        is_portal: bool,
        name: String,
    },
}
Expand description

Frontend (client → server) message types

Variants§

§

Startup

Startup message (sent first, no type byte)

Fields

§user: String

Database role / user name.

§database: String

Target database name.

§

PasswordMessage(String)

Password response (MD5 or cleartext).

§

Query(String)

Simple query (SQL text).

§

Parse

Parse (prepared statement)

Fields

§name: String

Prepared statement name (empty string = unnamed).

§query: String

SQL query text with $1-style parameter placeholders.

§param_types: Vec<u32>

OIDs of the parameter types (empty = server infers).

§

Bind

Bind parameters to prepared statement

Fields

§portal: String

Destination portal name (empty = unnamed).

§statement: String

Source prepared statement name.

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

Parameter values (None = SQL NULL).

§

Execute

Execute portal

Fields

§portal: String

Portal name to execute.

§max_rows: i32

Maximum rows to return (0 = no limit).

§

Sync

Sync — marks the end of an extended-query pipeline.

§

Terminate

Terminate — closes the connection.

§

SASLInitialResponse

SASL initial response (first message in SCRAM)

Fields

§mechanism: String

SASL mechanism name (e.g. SCRAM-SHA-256).

§data: Vec<u8>

Client-first message bytes.

§

SASLResponse(Vec<u8>)

SASL response (subsequent messages in SCRAM)

§

CopyFail(String)

CopyFail — abort a COPY IN with an error message

§

Close

Close — explicitly release a prepared statement or portal

Fields

§is_portal: bool

true for portal, false for prepared statement.

§name: String

Name of the portal or statement to close.

Implementations§

Source§

impl FrontendMessage

Source

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

Encode message to bytes for sending over the wire.

Trait Implementations§

Source§

impl Clone for FrontendMessage

Source§

fn clone(&self) -> FrontendMessage

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 FrontendMessage

Source§

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

Formats the value using the given formatter. Read more

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, 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> ColumnValue<Value> for T