Skip to main content

describe

hyperdb_api_core::protocol::message::frontend

Function describe 

Source 
pub fn describe(kind: u8, name: &str, buf: &mut BytesMut) -> Result<()>
Expand description

Writes a describe message.

Requests metadata about a prepared statement or portal. The server responds with RowDescription or ParameterDescription.

§Arguments

  • kind - ‘S’ for statement, ‘P’ for portal
  • name - Statement or portal name (null-terminated, empty string for unnamed)
  • buf - Buffer to write the message to

§Errors

Currently infallible — always returns Ok(()). The io::Result return type is preserved for forward compatibility.

§Panics

Panics via msg_len if name.len() exceeds i32::MAX bytes.