mysql-handler 0.2.0

Rust bindings for the MySQL handler
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
126
127
128
129

// Copyright (C) 2026 ren-yamanashi
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
//
// This program is designed to work with certain software (including
// but not limited to OpenSSL) that is licensed under separate terms,
// as designated in a particular file or component or in included license
// documentation. The authors of this program hereby grant you an additional
// permission to link the program and your derivative works with the
// separately licensed software that they have either included with
// the program or referenced in the documentation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, see <https://www.gnu.org/licenses/>.

//! `SecondaryEngineGraphSimplificationRequest` enum and its
//! `SecondaryEngineGraphSimplificationRequestParameters` struct from
//! `sql/handler.h`. Returned by [`Handlerton::secondary_engine_check_optimizer_request`].
//!
//! [`Handlerton::secondary_engine_check_optimizer_request`]: crate::hton::Handlerton::secondary_engine_check_optimizer_request

/// What the secondary engine asks the hypergraph optimizer to do next.
///
/// Mirrors `enum class SecondaryEngineGraphSimplificationRequest` in
/// `mysql-server/sql/handler.h`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum SecondaryEngineGraphSimplificationRequest {
    /// `kContinue = 0`: continue optimization with the current hypergraph.
    Continue,
    /// `kRestart = 1`: restart hypergraph with the provided subgraph-pair count.
    Restart,
}

impl SecondaryEngineGraphSimplificationRequest {
    /// Convert to the raw C value the shim packs into the C++ struct.
    #[must_use]
    pub const fn to_raw(self) -> i32 {
        match self {
            Self::Continue => 0,
            Self::Restart => 1,
        }
    }
}

/// The pair the secondary engine returns from
/// [`Handlerton::secondary_engine_check_optimizer_request`].
///
/// Mirrors `struct SecondaryEngineGraphSimplificationRequestParameters` in
/// `mysql-server/sql/handler.h`. Fields are crate-private and the type is
/// `#[non_exhaustive]` so a future MySQL field can land without a
/// SemVer-breaking change; engine code constructs values via [`Self::new`] or
/// [`Self::keep_going`] and reads them via [`Self::request`] /
/// [`Self::subgraph_pair_limit`].
///
/// [`Handlerton::secondary_engine_check_optimizer_request`]: crate::hton::Handlerton::secondary_engine_check_optimizer_request
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub struct SecondaryEngineOptimizerRequest {
    pub(crate) request: SecondaryEngineGraphSimplificationRequest,
    pub(crate) subgraph_pair_limit: i32,
}

impl SecondaryEngineOptimizerRequest {
    /// Construct a request from its two parts.
    #[must_use]
    pub const fn new(
        request: SecondaryEngineGraphSimplificationRequest,
        subgraph_pair_limit: i32,
    ) -> Self {
        Self {
            request,
            subgraph_pair_limit,
        }
    }

    /// "Keep going" default — what the trait returns when the engine has no
    /// opinion. Matches the upstream documented default (`kContinue`, 0).
    #[must_use]
    pub const fn keep_going() -> Self {
        Self::new(SecondaryEngineGraphSimplificationRequest::Continue, 0)
    }

    /// The transition the engine asks the optimizer to make.
    #[must_use]
    pub const fn request(&self) -> SecondaryEngineGraphSimplificationRequest {
        self.request
    }

    /// Subgraph-pair limit for the (possibly) restarted hypergraph.
    #[must_use]
    pub const fn subgraph_pair_limit(&self) -> i32 {
        self.subgraph_pair_limit
    }
}

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

    #[test]
    fn simplification_request_raw_round_trip() {
        assert_eq!(
            SecondaryEngineGraphSimplificationRequest::Continue.to_raw(),
            0
        );
        assert_eq!(
            SecondaryEngineGraphSimplificationRequest::Restart.to_raw(),
            1
        );
    }

    #[test]
    fn keep_going_default() {
        let r = SecondaryEngineOptimizerRequest::keep_going();
        assert_eq!(
            r.request,
            SecondaryEngineGraphSimplificationRequest::Continue
        );
        assert_eq!(r.subgraph_pair_limit, 0);
    }
}