Skip to main content

ColumnFormat

Enum ColumnFormat 

Source
pub enum ColumnFormat {
    Text,
    Binary,
    HyperBinary,
}
Expand description

Format code for column data.

This indicates how data values are encoded in the wire protocol. The format affects how values are serialized/deserialized and can significantly impact performance.

Variants§

§

Text

Text format (human-readable ASCII).

Values are sent as UTF-8 strings. Slower but human-readable. Use for debugging or when compatibility with text-based tools is needed.

§

Binary

Standard PostgreSQL binary format.

Uses PostgreSQL’s standard binary encoding (BigEndian for most types). Compatible with standard PostgreSQL clients.

§

HyperBinary

Hyper-specific binary format (little-endian, optimized).

Uses Hyper’s optimized binary format where all multi-byte values are little-endian (x86/ARM-LE native byte order), avoiding byte-swapping on modern hardware. This contrasts with standard PostgreSQL binary format which uses big-endian (network byte order).

Additional differences from PostgreSQL binary:

  • No per-row field count prefix (rows are implicitly framed)
  • NULL is a 1-byte indicator on nullable columns only (vs 4-byte -1 length)
  • Fixed-size types have no length prefix (vs 4-byte length in PG binary)

This is the fastest format and is used by default for query_fast(), query_streaming(), and the COPY bulk insertion path.

Implementations§

Source§

impl ColumnFormat

Source

pub fn from_code(code: i16) -> Self

Creates a ColumnFormat from the wire protocol format code.

Format codes: 0 = Text, 1 = Binary, 2 = HyperBinary

Source

pub fn to_code(self) -> i16

Returns the wire protocol format code.

Source

pub fn is_binary(self) -> bool

Returns true if this is a binary format (Binary or HyperBinary).

Trait Implementations§

Source§

impl Clone for ColumnFormat

Source§

fn clone(&self) -> ColumnFormat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ColumnFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ColumnFormat

Source§

fn default() -> ColumnFormat

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ColumnFormat

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for ColumnFormat

Source§

impl Eq for ColumnFormat

Source§

impl StructuralPartialEq for ColumnFormat

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more