Struct CancelKey 

pub struct CancelKey(/* private fields */);

Opaque cancellation secret carried by BackendKeyData and CancelRequest.

PostgreSQL 18 accepts 1 through 256 bytes when decoding a cancel request. A backend key has the stricter 4 through 256 byte range in protocol 3.2, and is exactly 4 bytes before protocol 3.2.

Implementations

impl CancelKey

pub fn new(bytes: impl Into<Vec<u8>>) -> Result<Self, PgWireError>

pub fn from_i32(secret_key: i32) -> Self

pub fn as_bytes(&self) -> &[u8]

pub fn into_bytes(self) -> Vec<u8>

pub fn with_middleware_prefix(&self, prefix: &[u8]) -> Result<Self, PgWireError>

Prefix middleware-owned routing data while retaining the complete downstream cancellation secret.

PostgreSQL does not prescribe a framing format for middleware data. Each layer therefore owns the prefix length it adds and passes that same length to Self::remove_middleware_prefix on the return path.

pub fn remove_middleware_prefix( &self, prefix_length: usize, ) -> Result<(Vec<u8>, Self), PgWireError>

Remove one middleware prefix and return both the layer data and the downstream cancellation secret.

pub fn validate_for_backend_key_data( &self, version: ProtocolVersion, ) -> Result<(), PgWireError>

Trait Implementations

impl AsRef<[u8]> for CancelKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CancelKey

fn clone(&self) -> CancelKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelKey

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

Formats the value using the given formatter.

impl Eq for CancelKey

impl From<i32> for CancelKey

fn from(secret_key: i32) -> Self

Converts to this type from the input type.

impl PartialEq for CancelKey

fn eq(&self, other: &CancelKey) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CancelKey