Struct EasyDB

pub struct EasyDB { /* private fields */ }

The main type for dealing with easydb.

Create an EasyDB using new or from_uuid_token.

Implementations

impl EasyDB

pub fn new() -> EdbResult<Self>

Creates an EasyDB using the easydb.toml in the current directory.

Errors

Will fail if the file cannot be read (e.g. when it doesn’t exist), or if the UUID or URL does not form a valid URL.

Example

let edb = EasyDB::new()?;

pub fn from_uuid_token( uuid: String, token: String, url: Option<String>, ) -> EdbResult<Self>

Creates an EasyDB using a UUID, Token, and optional URL (defaults to https://app.easydb.io/database/).

Errors

Will fail if url or uuid don’t form a valid URL.

Example

let edb = EasyDB::from_uuid_token("aaaa...".to_string(), "bbbb...".to_string(), None);

pub fn uuid(&self) -> &str

Returns the stored UUID.

pub fn token(&self) -> &str

Returns the stored token.

pub fn url(&self) -> &str

Returns the stored URL.

pub fn get(&self, key: &str) -> EdbResult<String>

Gets the value associated with key.

Example

let s = edb.get("somekey")?;

pub fn get_json(&self, key: &str) -> EdbResult<Json>

Gets the value associated with key in json format.

Example

let json = edb.get_json("somekey")?;

pub fn put(&self, key: &str, value: &str) -> EdbResult<u16>

Assigns value to key and returns the status code.

Example

let status = edb.put("somekey", "somevalue")?;

pub fn put_json(&self, key: &str, value: Json) -> EdbResult<u16>

Assigns a json value to key and returns the status code.

Example

let status = edb.put_json("somekey", json!({"a": "b"}))?;

pub fn delete(&self, key: &str) -> EdbResult<u16>

Deletes the value associated with key and returns the status code.

Example

let status = edb.delete("somekey")?;

pub fn list(&self) -> EdbResult<HashMap<String, String>>

Returns a HashMap<String, String> of all the data in this database.

Errors

Will fail if any of the values are not strings.

Example

let map = edb.list()?;

pub fn list_json(&self) -> EdbResult<HashMap<String, Json>>

Returns a HashMap<String, Json> of all the data in this database.

Example

let map = edb.list()?;

pub fn clear(&self) -> EdbResult<()>

Clears the database.

Example

edb.clear()?;
assert_eq!(edb.list()?.len(), 0);

pub fn get_writer<W>(&self, key: &str, value: &mut W) -> EdbResult<u16>

where W: Write,

An alternative to get() that works with a writer. Fetches data associated with key and writes into value, returning the status code.

The response should have the value that was originally set in JSON form. If the key was never set, was deleted, or has no data, the response will be an empty string: "".

pub fn list_writer<W>(&self, list: &mut W) -> EdbResult<u16>

where W: Write,

An alternative to list() that works with a writer. Fetches all the data in the database and writes it to list, returning the status code.

Trait Implementations

impl Debug for EasyDB

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EasyDB

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for EasyDB

fn from_str(s: &str) -> Result<Self, Self::Err>

Create an EasyDB from a &str in the TOML format.

Example

let s = r#"
UUID = "abcd"
Token = "efgh"
"#;
let edb: EasyDB = s.parse()?;
assert_eq!(edb.uuid(), "abcd");
assert_eq!(edb.token(), "efgh");

type Err = EdbError

The associated error which can be returned from parsing.

impl Serialize for EasyDB

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.