cartel-pg 0.26.0

Async PostgreSQL driver for the dope runtime
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
76
77
78
79
80
81
82
83
84
85

use crate::{
    protocol::runtime::waiters,
    reply::{self, server},
};
use dope::core::driver::route;
use dope::manifold::client::attempt;
use dope::net::link::pool::change::opening;
use std::cell;

pub(super) enum Failure<'d, const ID: u8> {
    Driver(crate::Error),
    Open(reply::Open<'d, ID>),
    Server(server::Diagnostic<'d>),
}

pub(crate) struct Signals<'d, const ID: u8> {
    pub(super) cause: cell::Cell<Option<Failure<'d, ID>>>,
    pub(crate) egress: waiters::Egress<'d>,
}

impl<'d, const ID: u8> Signals<'d, ID> {
    pub(crate) fn is_failed(&self) -> bool {
        // SAFETY: this observation neither mutates the cell nor calls user code.
        unsafe { &*self.cause.as_ptr() }.is_some()
    }

    pub(crate) fn failure(&self) -> Option<reply::Error<'d, ID>> {
        // SAFETY: copying errors and retaining the local diagnostic neither mutate
        // this cell nor call user code. No borrowed cause escapes this match.
        match unsafe { &*self.cause.as_ptr() } {
            Some(Failure::Driver(error)) => Some(reply::Error::Driver(*error)),
            Some(Failure::Open(cause)) => Some(reply::Error::Open(*cause)),
            Some(Failure::Server(error)) => Some(match error.try_clone() {
                Ok(error) => reply::Error::Server(error),
                Err(error) => reply::Error::Driver(crate::Error::ResponseRetain(error)),
            }),
            None => None,
        }
    }

    pub(crate) fn clear_open(&self) {
        // SAFETY: this observation ends before replacement and calls no user code.
        let clear = matches!(unsafe { &*self.cause.as_ptr() }, Some(Failure::Open(_)));
        if clear {
            // Open is Copy, so the replaced value needs no destruction.
            std::mem::forget(self.cause.replace(None));
        }
    }

    pub(crate) fn record_fatal(&self, error: crate::Error) {
        self.record_cause(Failure::Driver(error));
    }

    pub(in crate::protocol) fn record_reply(&self, error: server::Diagnostic<'d>) {
        self.record_cause(Failure::Server(error));
    }

    fn record_cause(&self, failure: Failure<'d, ID>) {
        // SAFETY: this observation ends before replacement or diagnostic destruction.
        let replace = matches!(
            unsafe { &*self.cause.as_ptr() },
            None | Some(Failure::Open(_))
        );
        if replace {
            // Only None or the Copy Open value can be replaced here.
            std::mem::forget(self.cause.replace(Some(failure)));
        }
    }

    pub(in crate::protocol) fn exhaust(
        &self,
        key: attempt::Id<'d, route::KeyTag<ID>>,
        cause: opening::Exhaustion,
    ) {
        self.record_cause(Failure::Open(reply::Open::Exhaustion { key, cause }));
    }

    pub(in crate::protocol) fn failed(
        &self,
        key: attempt::Id<'d, route::KeyTag<ID>>,
        cause: attempt::ConnectFault,
    ) {
        self.record_cause(Failure::Open(reply::Open::Transport { key, cause }));
    }
}