https://github.com/emreyalvac/firebase-rs

Rust based Firebase library
https://github.com/emreyalvac/firebase-rs

database firebase realtime-database rust server-sent-events

Last synced: 6 days ago
JSON representation

Rust based Firebase library

• Host: GitHub
• URL: https://github.com/emreyalvac/firebase-rs
• Owner: emreyalvac
• License: mit
• Created: 2020-04-27T11:09:57.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-20T18:30:54.000Z (about 2 months ago)
• Last Synced: 2024-12-28T20:03:41.532Z (13 days ago)
• Topics: database, firebase, realtime-database, rust, server-sent-events
• Language: Rust
• Homepage: https://crates.io/crates/firebase-rs
• Size: 101 KB
• Stars: 157
• Watchers: 2
• Forks: 20
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# firebase-rs

[![Crates.io](https://img.shields.io/crates/v/firebase-rs.svg)](https://crates.io/crates/firebase-rs) [![docs.rs](https://docs.rs/firebase-rs/badge.svg)](https://docs.rs/firebase-rs) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)

Rust based Firebase library.

---

![firebase](https://firebase.google.com/downloads/brand-guidelines/SVG/logo-logomark.svg 'Firebase')

# Full Documentation

[Documentation](https://docs.rs/firebase-rs/2.2.0/firebase_rs/)

# Features

- Server-Sent Events (a.k.a stream) (https://github.com/emreyalvac/firebase-rs#read-data-as-stream)

- Generic Payload

# How to use

### Load library

````rust

use firebase_rs::*;

````

### Without Auth

````rust

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

````

### With Auth

````rust

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

````

---

### At usage for nested objects

````rust

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

````

---

### Read Data as Stream

### With Real Time Events

````rust

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

let stream = firebase.with_realtime_events().unwrap();

stream

.listen( | event_type, data| {

println ! ("Type: {:?} Data: {:?}", event_type, data);

}, | err| println!("{:?}", err), false).await;

````

### Read Data

#### Read data as string

````rust

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

let users = firebase.get_as_string().await;

````

#### Read data with generic type (All)

````rust

#[derive(Serialize, Deserialize, Debug)]

struct User {

    name: String

}

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

let user = firebase.get::> ().await;

````

#### Read data with generic type (Single record)

````rust

#[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::().await;

````

---

### Set Data with Custom Key

````rust

#[derive(Serialize, Deserialize, Debug)]

struct User {

    name: String

}

let user = User { name: String::default () };

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

firebase.set_with_key("myKey", &user).await;

````

_Output_

```json

{

  "users": {

    "myKey": {

      "name": ""

    }

  }

}

```

### Set Data

````rust

#[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");

firebase.set(&user).await;

````

_Output_

```json

{

  "users": {

    "-OC9mYIUIdY3JygkmsFQ": {

      "name": ""

    }

  }

}

```

---

### Update Data

````rust

#[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");

firebase.update( &user).await;

````

---

### With Params

````rust

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().await;

````

## Contributors

Thanks goes to these wonderful people ✨