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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
//! # replit_db
//!
//! An unofficial database adapater for Replit Database for Rust!
//!
//! ## Usage
//!
//! You need to import [`Database`], [`Config`], and a trait ([`Synchronous`], [`Asynchronous`]).
//! Then initialize [`Database::new()`] with [`Config::new()`] then database will give you function in either synchronously or asynchronously based on trait you imported in to the scope.
//!
//! ## Possible Exceptions
//!
//! [`Error`] struct contain useful informations and both [`std::fmt::Display`] and [`std::error::Error`] (support "?").
//! Also there's different error kinds that can happens, here's the list of them.
//! - [`ErrorKind::HttpError`]
//! Raised when there's something wrong when doing HTTP request.
//! - [`ErrorKind::NoItemFoundError`]
//! Raised when item is not found
//! - [`ErrorKind::DecodeError`]
//! Raised when the key name is undecodable to UTF-8 string.
//!
//! ## Examples
//!
//! ### Example (Synchronous)
//!
//! ```rust,should_panic
//! use replit_db::{Synchronous, Error};
//!
//! fn main() -> Result<(), Error> {
//!
//! let db = replit_db::Database::new(replit_db::Config::new().unwrap());
//! db.get("Hello")?; // Get a value from key's name.
//! db.set("Hello", "World")?; // Set a value to that key
//! db.delete("Hello")?; // Delete a key
//! db.list(replit_db::STRING_NONE)?; // List all keys
//! db.list(Some("H"))?; // List keys with "H" prefix
//! return Ok(())
//! }
//! ```
//!
//! ### Example (Asynchronous)
//!
//! ```rust,should_panic
//! use replit_db::{Asynchronous, Error};
//!
//! use tokio;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Error> {
//!
//! let db = replit_db::Database::new(replit_db::Config::new().unwrap());
//! db.get("Hello").await?; // Get a value from key's name.
//! db.set("Hello", "World").await?; // Set a value to that key
//! db.delete("Hello").await?; // Delete a key
//! db.list(replit_db::STRING_NONE).await?; // List all keys
//! db.list(Some("H")).await?; // List keys with "H" prefix
//! return Ok(())
//! }
//! ```
use async_trait;
use reqwest;
use std;
use urlencoding;
/// This type is a shorthand for [`Option<&str>::None`] or [`None::<&str>`].
pub const STRING_NONE: Option<&str> = None;
/// Configuration struct that contains information needed for Database.
pub struct Config {
url: String,
}
#[derive(Debug, Clone)]
/// Error kind. (Http Error, No Item Found Error, Decode String Error)
pub enum ErrorKind {
/// Any [`reqwest`]'s errors will be here.
HttpError,
/// That item specified isn't exists in the database.
NoItemFoundError,
/// Couldn't decode bytes to string UTF-8.
DecodeError,
}
#[derive(Debug, Clone)]
/// Error struct for giving useful information about what goes wrong.
pub struct Error {
/// Error kind (See [`ErrorKind`])
pub kind: ErrorKind,
/// Message
pub message: String,
}
/// Database main struct.
/// Please use this database with traits. (Availables are [`Synchronous`] and [`Asynchronous`])
pub struct Database {
config: Config,
}
/// Synchronous support for Database struct. Use this trait by import it then use it right away!
pub trait Synchronous {
/// Set a variable. `key` and `value` MUST implement [`AsRef<str>`]. ([`str`] and [`String`] implemented this.).
/// Possible Exception is [`ErrorKind::HttpError`] for HttpError
fn set(&self, key: impl AsRef<str>, value: impl AsRef<str>) -> Result<(), Error>;
/// Get a variable you just set. `key` MUST implement [`AsRef<str>`]. ([`str`] and [`String`] implemented this.).
/// Possible Exceptions are [`ErrorKind::HttpError`] for HttpError, [`ErrorKind::NoItemFoundError`] for no items were found in the database
fn get(&self, key: impl AsRef<str>) -> Result<String, Error>;
/// Delete a variable you just set. MUST implement [`AsRef<str>`]. ([`str`] and [`String`] implemented this.).
/// Possible Exceptions are [`ErrorKind::HttpError`] for HttpError, [`ErrorKind::NoItemFoundError`] for no items were found in the database
fn delete(&self, key: impl AsRef<str>) -> Result<(), Error>;
/// List variables. Optionally finding variable that contains defined prefix by passing [`Some`] with anything that implements [`AsRef<str>`]. ([`str`] and [`String`] implemented this.) or [`STRING_NONE`].
/// Possible Exceptions are [`ErrorKind::HttpError`] for HttpError, [`ErrorKind::DecodeError`] Decoding string error.
fn list(&self, prefix: Option<impl AsRef<str>>) -> Result<std::vec::Vec<String>, Error>;
}
/// Asynchronous support for Database struct. Use this trait by import it then use it right away!
#[async_trait::async_trait]
pub trait Asynchronous {
/// Set a variable. `key` and `value` MUST implement [`AsRef<str>`]. ([`str`] and [`String`] implemented this.).
/// Possible Exception is [`ErrorKind::HttpError`] for HttpError
async fn set<T>(&self, key: T, value: T) -> Result<(), Error>
where
T: AsRef<str> + Send;
/// Get a variable you just set. `key` MUST implement [`AsRef<str>`]. ([`str`] and [`String`] implemented this.).
/// Possible Exceptions are [`ErrorKind::HttpError`] for HttpError, [`ErrorKind::NoItemFoundError`] for no items were found in the database
async fn get<T>(&self, key: T) -> Result<String, Error>
where
T: AsRef<str> + Send;
/// Delete a variable you just set. MUST implement [`AsRef<str>`]. ([`str`] and [`String`] implemented this.).
/// Possible Exceptions are [`ErrorKind::HttpError`] for HttpError, [`ErrorKind::NoItemFoundError`] for no items were found in the database
async fn delete<T>(&self, key: T) -> Result<(), Error>
where
T: AsRef<str> + Send;
/// List variables. Optionally finding variable that contains defined prefix by passing [`Some`] with anything that implements [`AsRef<str>`]. ([`str`] and [`String`] implemented this.) or [`STRING_NONE`].
/// Possible Exceptions are [`ErrorKind::HttpError`] for HttpError, [`ErrorKind::DecodeError`] Decoding string error.
async fn list<T>(&self, prefix: Option<T>) -> Result<std::vec::Vec<String>, Error>
where
T: AsRef<str> + Send;
}
impl Config {
/// Creating new [`Config`] struct with default configuration. (This will get Replit's Database URL through enviroment variable `REPLIT_DB_URL`)
/// With a possibility of [`std::env::VarError`] due to enviroment variable isn't exists.
/// If that happens, You should use [`Config`]'s `new_custom_url` for defining your own database URL instead.
pub fn new() -> Result<Config, std::env::VarError> {
let res = std::env::var("REPLIT_DB_URL");
match res {
Ok(r) => return Ok(Config { url: r }),
Err(e) => return Err(e)
}
}
/// Creating a new [`Config`] struct with custom URL configuration.
pub fn new_custom_url(url: &str) -> Config {
return Config {
url: url.to_owned(),
};
}
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
return f.write_str(format!("{:#?}: {}", self.kind, self.message).as_str());
}
}
impl std::error::Error for Error {} // Thanks nox!
impl Database {
/// Creating new Database instance with [`Config`] struct.
/// You still need traits for this struct to work.
pub fn new(config: Config) -> Self {
return Self { config: config };
}
}
impl Synchronous for Database {
fn set(&self, key: impl AsRef<str>, value: impl AsRef<str>) -> Result<(), Error> {
let client = reqwest::blocking::Client::new();
let payload = format!(
"{}={}",
urlencoding::encode(key.as_ref()),
urlencoding::encode(value.as_ref())
);
let response = client
.post(self.config.url.as_str().to_string())
.body(payload)
.header("Content-Type", "application/x-www-form-urlencoded")
.send();
if response.is_err() {
return Err(Error {
kind: ErrorKind::HttpError,
message: response.unwrap_err().to_string(),
});
}
return Ok(());
}
fn get(&self, key: impl AsRef<str>) -> Result<String, Error> {
let client = reqwest::blocking::Client::new();
let response = client
.get(
self.config.url.as_str().to_string()
+ format!("/{}", urlencoding::encode(key.as_ref())).as_str(),
)
.send();
// println!("{:#?}", response); debugging
if response.is_err() {
return Err(Error {
kind: ErrorKind::HttpError,
message: response.unwrap_err().to_string(),
});
}
let response = response.unwrap();
if !response.status().is_success() {
return Err(Error {
kind: ErrorKind::NoItemFoundError,
message: "No items were found on the database.".to_string(),
});
}
let content = response.text().unwrap();
return Ok(content);
}
fn delete(&self, key: impl AsRef<str>) -> Result<(), Error> {
let client = reqwest::blocking::Client::new();
let response = client
.delete(
self.config.url.as_str().to_string()
+ format!("/{}", urlencoding::encode(key.as_ref())).as_str(),
)
.send();
if response.is_err() {
return Err(Error {
kind: ErrorKind::HttpError,
message: response.unwrap_err().to_string(),
});
}
if !response.unwrap().status().is_success() {
return Err(Error {
kind: ErrorKind::NoItemFoundError,
message: "No item with that name were found.".to_string(),
});
}
return Ok(());
}
fn list(&self, prefix: Option<impl AsRef<str>>) -> Result<Vec<String>, Error> {
let prefix2 = match &prefix {
Some(p) => p.as_ref(),
None => "",
};
let client = reqwest::blocking::Client::new();
let response = client
.get(
self.config.url.as_str().to_string()
+ format!("?prefix={}", urlencoding::encode(prefix2)).as_str(),
)
.send();
if response.is_err() {
return Err(Error {
kind: ErrorKind::HttpError,
message: response.unwrap_err().to_string(),
});
}
let content = response.unwrap().text();
if content.is_err() {
return Err(Error {
kind: ErrorKind::DecodeError,
message: content.unwrap_err().to_string(),
});
}
let mut variables: std::vec::Vec<String> = std::vec::Vec::new();
for v in content.unwrap().lines() {
variables.push(v.to_string());
}
return Ok(variables);
}
}
#[async_trait::async_trait]
impl Asynchronous for Database {
async fn set<T>(&self, key: T, value: T) -> Result<(), Error>
where
T: AsRef<str> + Send,
{
let client = reqwest::Client::new();
let payload = format!(
"{}={}",
urlencoding::encode(key.as_ref()),
urlencoding::encode(value.as_ref())
);
let response = client
.post(self.config.url.as_str().to_string())
.header("Content-Type", "application/x-www-form-urlencoded")
.body(payload)
.send()
.await;
if response.is_err() {
return Err(Error {
kind: ErrorKind::HttpError,
message: response.unwrap_err().to_string(),
});
}
return Ok(());
}
async fn get<T>(&self, key: T) -> Result<String, Error>
where
T: AsRef<str> + Send,
{
let client = reqwest::Client::new();
let response = client
.get(
self.config.url.as_str().to_string()
+ format!("/{}", urlencoding::encode(key.as_ref())).as_str(),
)
.send()
.await;
if response.is_err() {
return Err(Error {
kind: ErrorKind::HttpError,
message: response.unwrap_err().to_string(),
});
}
let response = response.unwrap();
if !response.status().is_success() {
return Err(Error {
kind: ErrorKind::NoItemFoundError,
message: "No items were found on the database.".to_string(),
});
}
let content = response.text().await.unwrap();
return Ok(content);
}
async fn delete<T>(&self, key: T) -> Result<(), Error>
where
T: AsRef<str> + Send,
{
let client = reqwest::Client::new();
let response = client
.delete(
self.config.url.as_str().to_string()
+ format!("/{}", urlencoding::encode(key.as_ref())).as_str(),
)
.send()
.await;
if response.is_err() {
return Err(Error {
kind: ErrorKind::HttpError,
message: response.unwrap_err().to_string(),
});
}
if !response.unwrap().status().is_success() {
return Err(Error {
kind: ErrorKind::NoItemFoundError,
message: "No item with that name were found.".to_string(),
});
}
return Ok(());
}
async fn list<T>(&self, prefix: Option<T>) -> Result<Vec<String>, Error>
where
T: AsRef<str> + Send,
{
let prefix2 = match &prefix {
Some(p) => p.as_ref(),
None => "",
};
let client = reqwest::Client::new();
let response = client
.get(
self.config.url.as_str().to_string()
+ format!("?prefix={}", urlencoding::encode(prefix2)).as_str(),
)
.send()
.await;
if response.is_err() {
return Err(Error {
kind: ErrorKind::HttpError,
message: response.unwrap_err().to_string(),
});
}
let content = response.unwrap().text().await;
if content.is_err() {
return Err(Error {
kind: ErrorKind::DecodeError,
message: content.unwrap_err().to_string(),
});
}
let mut variables: std::vec::Vec<String> = std::vec::Vec::new();
for v in content.unwrap().lines() {
variables.push(v.to_string());
}
return Ok(variables);
}
}