Struct ConnectionState

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

ASCII state diagram for the connection state machine

stateDiagram-v2
    [*] --> SslInitializing: SSL not disabled
    [*] --> Initializing: SSL disabled
    SslInitializing --> SslWaiting: Send SSL request
    SslWaiting --> SslConnecting: SSL accepted
    SslWaiting --> Connecting: SSL rejected (if not required)
    SslConnecting --> Connecting: SSL handshake complete
    Initializing --> Connecting: Send startup message
    Connecting --> Connected: Authentication successful
    Connecting --> Scram: SCRAM auth requested
    Scram --> Connected: SCRAM auth successful
    Connected --> Ready: Parameter sync complete
    Ready --> [*]: Connection closed
    state Error {
        [*] --> [*]: Any state can transition to Error
    }

The state machine for a Postgres connection. The state machine is driven with calls to Self::drive.

Implementations

impl ConnectionState

pub fn new(credentials: Credentials, ssl_mode: ConnectionSslRequirement) -> Self

pub fn is_ready(&self) -> bool

pub fn is_error(&self) -> bool

pub fn is_done(&self) -> bool

pub fn read_ssl_response(&self) -> bool

pub fn drive( &mut self, drive: ConnectionDrive<'_>, update: &mut impl ConnectionStateUpdate, ) -> Result<(), ConnectionError>

Trait Implementations

impl Debug for ConnectionState

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

Formats the value using the given formatter.