pg_stream 0.2.0

A low-level, zero-overhead Rust implementation of the Postgres wire protocol.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! Backend message types and parsing.
//!
//! This module provides types for representing and parsing PostgreSQL backend
//! (server-to-client) messages.

mod code;
mod io;
mod parse;
mod wrappers;

pub use code::MessageCode;
#[cfg(feature = "async")]
pub use io::read_message;
#[cfg(feature = "sync")]
pub use io::read_message_sync;
pub use wrappers::{
    BackendKeyData, CommandComplete, CopyResponse, DataRow, ErrorResponse, NoticeResponse,
    NotificationResponse, ParameterDescription, ParameterStatus, ReadyForQuery, RowDescription,
    TransactionStatus,
};

use bytes::Bytes;

/// A parsed PostgreSQL backend message.
///
/// This enum represents all backend message types. Messages are automatically
/// parsed when reading from a connection.
#[derive(Debug, Clone)]
pub enum PgMessage {
    // Query results
    DataRow(DataRow),
    RowDescription(RowDescription),
    CommandComplete(CommandComplete),
    EmptyQueryResponse,

    // Errors and notices
    ErrorResponse(ErrorResponse),
    NoticeResponse(NoticeResponse),

    // Connection state
    ReadyForQuery(ReadyForQuery),
    BackendKeyData(BackendKeyData),
    ParameterStatus(ParameterStatus),

    // Prepared statements
    ParseComplete,
    BindComplete,
    CloseComplete,
    ParameterDescription(ParameterDescription),
    NoData,
    PortalSuspended,

    // Notifications
    NotificationResponse(NotificationResponse),

    // Copy protocol
    CopyData(Bytes),
    CopyDone,
    CopyInResponse(CopyResponse),
    CopyOutResponse(CopyResponse),
    CopyBothResponse(CopyResponse),

    // Authentication (body preserved for caller to interpret)
    Authentication(Bytes),

    // Misc
    FunctionCallResponse(Bytes),
    NegotiateProtocolVersion(Bytes),

    /// An unrecognized message code. The raw code and body are preserved.
    Unknown {
        code: MessageCode,
        body: Bytes,
    },
}