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

// 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/>.

//! `Ha_clone_mode` and `Ha_clone_type` from `sql/handler.h`. Used as the
//! `mode` / `type` arguments to the clone interface trait methods.

/// Mode for starting a clone operation.
///
/// Mirrors `enum Ha_clone_mode` in `mysql-server/sql/handler.h`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum HaCloneMode {
    /// `HA_CLONE_MODE_START`: first start of a clone.
    Start,
    /// `HA_CLONE_MODE_RESTART`: restart of a previously paused clone.
    Restart,
    /// `HA_CLONE_MODE_ADD_TASK`: add a worker task to an existing clone.
    AddTask,
    /// `HA_CLONE_MODE_VERSION`: query supported version.
    Version,
    /// `HA_CLONE_MODE_MAX`: sentinel; treated as `Start` for forward-compat.
    Max,
}

impl HaCloneMode {
    /// Decode the C `enum Ha_clone_mode` value. Unknown values fall back to
    /// [`HaCloneMode::Start`].
    #[must_use]
    pub const fn from_raw(value: u32) -> Self {
        match value {
            1 => Self::Restart,
            2 => Self::AddTask,
            3 => Self::Version,
            4 => Self::Max,
            _ => Self::Start,
        }
    }
}

/// Clone-transfer type the source engine should perform.
///
/// Mirrors `enum Ha_clone_type` in `mysql-server/sql/handler.h`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum HaCloneType {
    /// `HA_CLONE_BLOCKING`: serialised copy (write operations must block).
    Blocking,
    /// `HA_CLONE_REDO`: archive redo log to support concurrent DML.
    Redo,
    /// `HA_CLONE_PAGE`: page-tracked incremental.
    Page,
    /// `HA_CLONE_HYBRID`: page tracking + redo (currently InnoDB).
    Hybrid,
    /// `HA_CLONE_MULTI_TASK`: multiple worker threads.
    MultiTask,
    /// `HA_CLONE_RESTART`: restart after network failure.
    Restart,
    /// Forward-compatible fallback.
    Unknown,
}

impl HaCloneType {
    /// Decode the C `enum Ha_clone_type` value (a `size_t` upstream).
    #[must_use]
    pub const fn from_raw(value: usize) -> Self {
        match value {
            0 => Self::Blocking,
            1 => Self::Redo,
            2 => Self::Page,
            3 => Self::Hybrid,
            4 => Self::MultiTask,
            5 => Self::Restart,
            _ => Self::Unknown,
        }
    }
}

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

    #[test]
    fn clone_mode_known_values() {
        assert_eq!(HaCloneMode::from_raw(0), HaCloneMode::Start);
        assert_eq!(HaCloneMode::from_raw(1), HaCloneMode::Restart);
        assert_eq!(HaCloneMode::from_raw(2), HaCloneMode::AddTask);
        assert_eq!(HaCloneMode::from_raw(3), HaCloneMode::Version);
        assert_eq!(HaCloneMode::from_raw(4), HaCloneMode::Max);
        assert_eq!(HaCloneMode::from_raw(99), HaCloneMode::Start);
    }

    #[test]
    fn clone_type_known_values() {
        assert_eq!(HaCloneType::from_raw(0), HaCloneType::Blocking);
        assert_eq!(HaCloneType::from_raw(1), HaCloneType::Redo);
        assert_eq!(HaCloneType::from_raw(2), HaCloneType::Page);
        assert_eq!(HaCloneType::from_raw(3), HaCloneType::Hybrid);
        assert_eq!(HaCloneType::from_raw(4), HaCloneType::MultiTask);
        assert_eq!(HaCloneType::from_raw(5), HaCloneType::Restart);
        assert_eq!(HaCloneType::from_raw(99), HaCloneType::Unknown);
    }
}