Struct NativeResponse 

pub struct NativeResponse {
    pub seq: u64,
    pub status: ResponseStatus,
    pub columns: Option<Vec<String>>,
    pub rows: Option<Vec<Vec<Value>>>,
    pub rows_affected: Option<u64>,
    pub command: Option<String>,
    pub watermark_lsn: u64,
    pub error: Option<ErrorPayload>,
    pub auth: Option<AuthResponse>,
    pub warnings: Vec<String>,
}

A response sent from server to client over the native protocol.

Fields

seq: u64

Echoed from the request for correlation.

status: ResponseStatus

Execution outcome.

columns: Option<Vec<String>>

Column names (for query results).

rows: Option<Vec<Vec<Value>>>

Row data (for query results). Each row is a Vec of Values.

rows_affected: Option<u64>

Number of rows affected (for writes).

command: Option<String>

The statement’s command verb (INSERT, UPDATE, DELETE, UPSERT, MERGE, TRUNCATE, …). None when the statement produced no DML outcome.

watermark_lsn: u64

WAL LSN watermark at time of computation.

error: Option<ErrorPayload>

Error details (if status == Error).

auth: Option<AuthResponse>

Auth response (if op == Auth and status == Ok).

warnings: Vec<String>

Advisory warnings (e.g. password expiry grace period, must_change_password). Empty in the common case; #[serde(default)] and #[msgpack(default)] keep this additive and backward-compatible with older clients.

Implementations

impl NativeResponse

pub fn ok(seq: u64) -> Self

Create a successful response with no data.

pub fn from_query_result(seq: u64, qr: QueryResult, lsn: u64) -> Self

Create a successful response from a QueryResult.

pub fn error( seq: u64, code: impl Into<String>, message: impl Into<String>, ) -> Self

Create an error response that carries only a SQLSTATE.

Use Self::error_with_code wherever the numeric NodeDB code is known: a frame built here reaches the client with ndb_code == 0 and collapses to a generic internal error on the far side.

pub fn error_with_code( seq: u64, code: impl Into<String>, message: impl Into<String>, ndb_code: u16, ) -> Self

Create an error response carrying both the SQLSTATE and the stable numeric NodeDB code, so the client can rebuild the typed error rather than inferring one from a many-to-one SQLSTATE.

pub fn with_error_details(self, details: ErrorDetails) -> Self

Attach the structured error details to an error response. A response with no error payload is returned unchanged.

pub fn with_error_cause(self, cause: ErrorCausePayload) -> Self

Attach the typed cause to an error response. A response with no error payload is returned unchanged.

pub fn auth_ok(seq: u64, username: String, tenant_id: u64) -> Self

Create an auth success response.

pub fn status_row(seq: u64, message: impl Into<String>) -> Self

Create a response with a single “status” column and one row.

Trait Implementations

impl Clone for NativeResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NativeResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NativeResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for NativeResponse

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>

where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl Serialize for NativeResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessagePack for NativeResponse

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.

fn size_hint(&self) -> Option<TrustedSizeHint>

Returns a trusted upper bound for the number of bytes written by the next call to Self::write, or None when it cannot be determined cheaply.

fn max_size() -> Option<TrustedSizeHint>

Returns a trusted upper bound valid for every value of this type.

fn write_slice<W>(values: &[Self], writer: &mut W) -> Result<(), Error>

where W: Write, Self: Sized,

Writes the MessagePack representation of a slice of values into the provided writer.