ydb 0.17.1

Crate contains generated low-level grpc code from YDB API protobuf, used as base for ydb crate
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use std::future::IntoFuture;
use std::marker::PhantomData;
use std::time::Duration;

use futures_util::future::BoxFuture;

use crate::Transaction;
use crate::TransactionOptions;
use crate::TxMode;
use crate::async_closure::AsyncFnMut;
use crate::async_closure::DynAsyncFnMut;
use crate::async_closure::with_lifetime::MutWithLifetime;
use crate::errors::YdbResultWithCustomerErr;

use super::QueryClient;

/// Builder for [`QueryClient::retry_tx`].
pub struct RetryTxBuilder<'a, F, T> {
    client: &'a QueryClient,
    callback: F,
    options: TransactionOptions,
    timeout: Option<Duration>,
    idempotent: bool,
    _phantom: PhantomData<fn() -> T>,
}

/// Auxiliary trait for closures that can be passed into [`QueryClient::retry_tx`].
pub trait RetryTxAttempt<T>: Send {
    fn attempt<'a>(
        &'a mut self,
        tx: &'a mut Transaction,
    ) -> BoxFuture<'a, YdbResultWithCustomerErr<T>>;
}

impl<'c, T> RetryTxAttempt<T>
    for DynAsyncFnMut<'c, MutWithLifetime<Transaction>, YdbResultWithCustomerErr<T>>
{
    fn attempt<'a>(
        &'a mut self,
        tx: &'a mut Transaction,
    ) -> BoxFuture<'a, YdbResultWithCustomerErr<T>> {
        self.call(tx)
    }
}

impl<'a, F, T> RetryTxBuilder<'a, F, T> {
    pub(crate) fn new(client: &'a QueryClient, callback: F) -> Self {
        Self {
            client,
            callback,
            options: TransactionOptions::default(),
            timeout: None,
            idempotent: false,
            _phantom: PhantomData,
        }
    }

    /// Transaction isolation mode (default: [`TxMode::SerializableReadWrite`]).
    pub fn with_mode(mut self, mode: TxMode) -> Self {
        self.options = self.options.with_mode(mode);
        self
    }

    /// Alias for [`Self::with_mode`].
    pub fn isolation(self, mode: TxMode) -> Self {
        self.with_mode(mode)
    }

    /// Call `BeginTransaction` RPC before the first `ExecuteQuery`.
    pub fn with_begin(mut self) -> Self {
        self.options = self.options.with_begin();
        self
    }

    /// Also retry errors that require idempotency (see [`crate::CallBuilder::idempotent`]).
    pub fn idempotent(mut self, idempotent: bool) -> Self {
        self.idempotent = idempotent;
        self
    }

    /// Wall-clock limit for the whole `retry_tx` call (all attempts, backoff, and in-callback RPCs).
    pub fn timeout(mut self, timeout: Duration) -> Self {
        self.timeout = Some(timeout);
        self
    }
}

impl<'a, F, T> IntoFuture for RetryTxBuilder<'a, F, T>
where
    F: RetryTxAttempt<T>,
    F: 'a,
    T: Send + 'a,
{
    type Output = YdbResultWithCustomerErr<T>;
    type IntoFuture = BoxFuture<'a, Self::Output>;

    fn into_future(self) -> Self::IntoFuture {
        Box::pin(self.client.run_retry_tx(
            self.callback,
            self.options,
            self.timeout,
            self.idempotent,
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::closure;

    const fn assert_send<T: Send>(value: T) -> T {
        value
    }

    // This compile-time test asserts that `retry_tx` future is `Send`.
    #[allow(unused)]
    fn compile_time_test_retry_tx_is_send(qc: &QueryClient) {
        assert_send(qc.retry_tx(closure!(async |tx: &mut Transaction| {
            tx.exec("SELECT 1").await?;
            Ok(())
        })));
    }
}