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

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

//! Index-lookup search semantics, mirroring MySQL's `ha_rkey_function`.

/// Search semantics for an index lookup, mirroring MySQL's `ha_rkey_function`.
///
/// Passed to [`StorageEngine::index_read_map`] to describe how the supplied key
/// should be matched: an exact hit, the nearest neighbour in a direction, a
/// prefix, or one of the spatial (minimum-bounding-rectangle) relations.
///
/// [`StorageEngine::index_read_map`]: crate::engine::StorageEngine::index_read_map
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum RKeyFunction {
    /// Find the first record with exactly this key, else error
    KeyExact,
    /// This record or the next one
    KeyOrNext,
    /// This record or the previous one
    KeyOrPrev,
    /// First record after this key
    AfterKey,
    /// First record before this key
    BeforeKey,
    /// First record sharing this key prefix
    Prefix,
    /// Last record sharing this key prefix
    PrefixLast,
    /// Last record with this prefix, or the previous one
    PrefixLastOrPrev,
    /// Minimum bounding rectangle contains the key
    MbrContain,
    /// Minimum bounding rectangle intersects the key
    MbrIntersect,
    /// Minimum bounding rectangle is within the key
    MbrWithin,
    /// Minimum bounding rectangle is disjoint from the key
    MbrDisjoint,
    /// Minimum bounding rectangle equals the key
    MbrEqual,
    /// Nearest-neighbour spatial search
    NearestNeighbor,
    /// Unrecognised value; MySQL's `HA_READ_INVALID` or an out-of-range code
    Invalid,
}

impl RKeyFunction {
    /// Map the raw `ha_rkey_function` integer supplied at the FFI boundary to a
    /// variant. Any unknown code (including `HA_READ_INVALID == -1`) becomes
    /// [`RKeyFunction::Invalid`] so the engine never observes an undefined value.
    pub(crate) fn from_raw(raw: i32) -> Self {
        match raw {
            0 => Self::KeyExact,
            1 => Self::KeyOrNext,
            2 => Self::KeyOrPrev,
            3 => Self::AfterKey,
            4 => Self::BeforeKey,
            5 => Self::Prefix,
            6 => Self::PrefixLast,
            7 => Self::PrefixLastOrPrev,
            8 => Self::MbrContain,
            9 => Self::MbrIntersect,
            10 => Self::MbrWithin,
            11 => Self::MbrDisjoint,
            12 => Self::MbrEqual,
            13 => Self::NearestNeighbor,
            _ => Self::Invalid,
        }
    }
}

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

    #[test]
    fn maps_known_codes() {
        assert_eq!(RKeyFunction::from_raw(0), RKeyFunction::KeyExact);
        assert_eq!(RKeyFunction::from_raw(7), RKeyFunction::PrefixLastOrPrev);
        assert_eq!(RKeyFunction::from_raw(13), RKeyFunction::NearestNeighbor);
    }

    #[test]
    fn unknown_codes_become_invalid() {
        assert_eq!(RKeyFunction::from_raw(-1), RKeyFunction::Invalid);
        assert_eq!(RKeyFunction::from_raw(14), RKeyFunction::Invalid);
        assert_eq!(RKeyFunction::from_raw(i32::MAX), RKeyFunction::Invalid);
    }
}