mysql_handler/prelude.rs
1// Copyright (C) 2026 ren-yamanashi
2//
3// This program is free software; you can redistribute it and/or modify
4// it under the terms of the GNU General Public License, version 2.0,
5// as published by the Free Software Foundation.
6//
7// This program is designed to work with certain software (including
8// but not limited to OpenSSL) that is licensed under separate terms,
9// as designated in a particular file or component or in included license
10// documentation. The authors of this program hereby grant you an additional
11// permission to link the program and your derivative works with the
12// separately licensed software that they have either included with
13// the program or referenced in the documentation.
14//
15// This program is distributed in the hope that it will be useful,
16// but WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18// GNU General Public License for more details.
19//
20// You should have received a copy of the GNU General Public License
21// along with this program; if not, see <https://www.gnu.org/licenses/>.
22
23//! Aggregated re-exports for downstream engine crates.
24//!
25//! `use mysql_handler::prelude::*;` brings the items most engine
26//! implementations reach for: the [`StorageEngine`] trait and its
27//! [`EngineError`] / [`EngineResult`] types, the [`License`] tag for
28//! the plugin manifest, and the [`plugin`] attribute macro that
29//! generates it.
30
31pub use crate::engine::{EngineError, EngineResult, RKeyFunction, RangeKey, StorageEngine};
32pub use crate::license::License;
33pub use mysql_handler_macros::plugin;