Skip to main content

Transport

Enum Transport 

Source
#[non_exhaustive]
pub enum Transport { Tcp(TcpVariant), Unix(UnixStream), }
Expand description

Transport layer abstraction

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Tcp(TcpVariant)

TCP socket (plain or TLS)

§

Unix(UnixStream)

Unix domain socket

Implementations§

Source§

impl Transport

Source

pub async fn connect_tcp(host: &str, port: u16) -> Result<Self>

Connect via plain TCP

§Errors

Returns WireError if the TCP connection to host:port fails.

Source

pub async fn connect_tcp_tls( host: &str, port: u16, tls_config: &TlsConfig, ) -> Result<Self>

Connect via TLS-encrypted TCP using PostgreSQL SSL negotiation protocol.

PostgreSQL requires a specific SSL upgrade sequence:

  1. Send SSLRequest message (8 bytes)
  2. Server responds with ‘S’ (accept) or ‘N’ (reject)
  3. If accepted, perform TLS handshake
§Errors

Returns WireError::Io if the TCP connection or TLS handshake fails. Returns WireError::Config if the server rejects the SSL request.

Source

pub async fn connect_unix(path: &Path) -> Result<Self>

Connect via Unix socket

§Errors

Returns WireError if the Unix domain socket connection to path fails.

Source

pub async fn write_all(&mut self, buf: &[u8]) -> Result<()>

Write bytes to the transport

§Errors

Returns WireError if the underlying I/O write fails.

Source

pub async fn flush(&mut self) -> Result<()>

Flush the transport

§Errors

Returns WireError if the underlying I/O flush fails.

Source

pub async fn read_buf(&mut self, buf: &mut BytesMut) -> Result<usize>

Read bytes into buffer

§Errors

Returns WireError if the underlying I/O read fails.

Source

pub async fn shutdown(&mut self) -> Result<()>

Shutdown the transport

§Errors

Returns WireError if the underlying I/O shutdown fails.

Source

pub fn apply_keepalive(&self, idle: Duration) -> Result<()>

Apply TCP keepalive to this transport, if it is a TCP connection.

A no-op for Unix socket transports (keepalive is a TCP-layer feature). Logs a warning and returns Ok(()) rather than failing if the platform does not support the requested keepalive interval.

§Errors

Returns WireError if setting the socket keepalive options fails on a TCP transport.

Trait Implementations§

Source§

impl Debug for Transport

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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