Struct firebase_rs::Firebase

pub struct Firebase { /* private fields */ }

Implementations

impl Firebase

pub fn new(uri: &str) -> Result<Self, UrlParseError>

where Self: Sized,

use firebase_rs::Firebase;

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap();

pub fn auth(uri: &str, auth_key: &str) -> Result<Self, UrlParseError>

where Self: Sized,

const URI: &str = "...";
const AUTH_KEY: &str = "...";

use firebase_rs::Firebase;

let firebase = Firebase::auth("https://myfirebase.firebaseio.com", AUTH_KEY).unwrap();

pub fn with_params(&self) -> Params

use firebase_rs::Firebase;

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().with_params().start_at(1).order_by("name").equal_to(5).finish();
let result = firebase.get::<String>().await;

pub fn with_realtime_events(&self) -> Option<ServerEvents>

To use simple interface with synchronous callbacks, pair with .listen():

use firebase_rs::Firebase;
let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
let stream = firebase.with_realtime_events().unwrap();
stream.listen(|event_type, data| {
                    println!("{:?} {:?}" ,event_type, data);
                }, |err| println!("{:?}" ,err), false).await;

To use streaming interface for async code, pair with .stream():

use firebase_rs::Firebase;
use futures_util::StreamExt;

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
let stream = firebase.with_realtime_events()
             .unwrap()
             .stream(true);
stream.for_each(|event| {
          match event {
              Ok((event_type, maybe_data)) => println!("{:?} {:?}" ,event_type, maybe_data),
              Err(err) => println!("{:?}" ,err),
          }
          futures_util::future::ready(())
       }).await;

pub fn at(&self, path: &str) -> Self

use firebase_rs::Firebase;

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users").at("USER_ID").at("f69111a8a5258c15286d3d0bd4688c55");

pub fn get_uri(&self) -> String

use firebase_rs::Firebase;

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
let uri = firebase.get_uri();

pub async fn set<T>(&self, data: &T) -> Result<Response, RequestError>

where T: Serialize + DeserializeOwned + Debug,

use firebase_rs::Firebase;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug)]
struct User {
   name: String
}

let user = User { name: String::default() };
let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
let users = firebase.set(&user).await;

pub async fn get_as_string(&self) -> Result<Response, RequestError>

use std::collections::HashMap;
use firebase_rs::Firebase;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug)]
struct User {
   name: String
}

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
let users = firebase.get::<HashMap<String, User>>().await;

pub async fn get<T>(&self) -> Result<T, RequestError>

where T: Serialize + DeserializeOwned + Debug,

use std::collections::HashMap;
use firebase_rs::Firebase;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug)]
struct User {
    name: String
}

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users").at("USER_ID");
let user = firebase.get::<User>().await;

 // OR

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users");
let user = firebase.get::<HashMap<String, User>>().await;

pub async fn delete(&self) -> Result<Response, RequestError>

use firebase_rs::Firebase;

let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users").at("USER_ID");
firebase.delete().await;

pub async fn update<T>(&self, data: &T) -> Result<Response, RequestError>

where T: DeserializeOwned + Serialize + Debug,

use firebase_rs::Firebase;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug)]
struct User {
    name: String
}

let user = User { name: String::default() };
let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap().at("users").at("USER_ID");
let users = firebase.update(&user).await;

Trait Implementations

impl Debug for Firebase

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

Formats the value using the given formatter.