yodb 0.0.0

Placeholder. yo is an embedded multi-model database in Rust; this package will hold the engine itself. Not yet usable.
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

//! Placeholder. yo is an embedded multi-model database in Rust; this package will hold the engine itself. Not yet usable.
//!
//! The real release lands at milestone DX6 (M7). Until then this package does nothing.

#![forbid(unsafe_code)]
#![deny(missing_docs)]

/// The message every placeholder in every ecosystem raises with.
pub const NOT_YET: &str = "yo is not usable yet. This is a reserved placeholder at 0.0.0; see https://github.com/tamnd/yo";

/// Opens a database. Always panics: this version is a reserved placeholder.
///
/// It panics rather than returning an error because there is no error a caller
/// could handle. Nothing about the argument is wrong; the package is empty.
pub fn open(_path: &str) -> ! {
    panic!("{NOT_YET}");
}

#[cfg(test)]
mod tests {
    #[test]
    #[should_panic(expected = "not usable yet")]
    fn open_panics() {
        super::open("x.yo");
    }
}