Hyperdb Rs

HyperDB Rust is a Rust crate for the HyperDB server.

Rust

Project Details

HyperDB Rust Client

Author: Afaan Bilal

Introduction

HyperDB Rust is a Rust client crate for the HyperDB server.

Installation

cargo add hyperdb-rs

Example usage

use hyperdb_rs;

let mut hyper = hyperdb_rs::HyperClient::new(String::from("http://localhost:8765"));

// Ping the server
let mut r = hyper.ping().expect("failed");
println!("{}", r); // PONG

// Get the version number
r = hyper.version().expect("failed");
println!("{}", r); // "[HyperDB v0.2.0 (https://afaan.dev)]"

// Set a value
r = hyper.set("test", "value").expect("failed");
println!("{}", r); // value

// Check if a key is present
r = hyper.has("test").expect("failed");
println!("{}", r); // YES

// Get a value
r = hyper.get("test").expect("failed");
println!("{}", r); // value

// Get all stored data
r = hyper.all().expect("failed");
println!("{}", r); // {"test": "value"}

// Remove a key
r = hyper.delete("test").expect("failed");
println!("{}", r); // OK

// Delete all stored data
r = hyper.clear().expect("failed");
println!("{}", r); // OK

// Check if the store is empty
r = hyper.empty().expect("failed");
println!("{}", r); // YES

// Persist the store to disk
r = hyper.save().expect("failed");
println!("{}", r); // OK

// Reload the store from disk
r = hyper.reload().expect("failed");
println!("{}", r); // OK

// Delete all store data from memory and disk
r = hyper.reset().expect("failed");
println!("{}", r); // OK

Test

cargo test

Contributing

All contributions are welcome. Please create an issue first for any feature request
or bug. Then fork the repository, create a branch and make any changes to fix the bug
or add the feature and create a pull request. That's it!
Thanks!

License

HyperDB Rust is released under the MIT License.
Check out the full license here.

License

MIT License

Copyright (c) 2023 Afaan Bilal

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.