Struct FirebaseRTDB

Source
pub struct FirebaseRTDB {
    pub base_url: String,
    pub auth: AuthResponsePayload,
    pub expire_time: Instant,
    pub api_key: String,
    pub jwt: String,
    /* private fields */
}
Expand description

Firebase Realtime Database client with JWT authentication support.

This struct maintains the authentication state and provides access to database operations. It automatically handles token renewal and maintains connection settings.

§Fields

  • base_url - The base URL of your Firebase project
  • client - HTTP client with connection pooling and TLS support
  • auth - Current authentication state including tokens
  • expire_time - Token expiration timestamp
  • api_key - Firebase project API key
  • jwt - Original JWT token for renewals

Fields§

§base_url: String§auth: AuthResponsePayload§expire_time: Instant§api_key: String§jwt: String

Implementations§

Source§

impl FirebaseRTDB

Source

pub async fn new_from_jwt<T: Into<String>, R: Into<String>, V: AsRef<str>>( project_url: T, jwt: R, api_key: V, ) -> Result<Self, RtdbError>

Creates a new Firebase RTDB client using a JWT token.

This method will contact the authorization server to obtain necessary credentials. The JWT token is used for initial authentication and subsequent token renewals.

§Arguments
  • project_url - The base URL of your Firebase project (e.g., “https://project-id.firebaseio.com”)
  • jwt - A valid JWT token for authentication
  • api_key - Your Firebase project’s API key
§Returns

Returns a Result containing the initialized FirebaseRTDB client or an error

Source

pub fn new_from_token<T: Into<String>, R: Into<String>, V: Into<String>>( project_url: T, api_key: R, jwt: V, auth: AuthResponsePayload, expire_time: Instant, ) -> Result<Self, RtdbError>

Creates a new Firebase RTDB client using an existing valid token.

Use this method when you already have valid authentication credentials and want to avoid an initial token refresh.

§Arguments
  • project_url - The base URL of your Firebase project
  • api_key - Your Firebase project’s API key
  • jwt - A valid JWT token
  • auth - Existing authentication payload
  • expire_time - Token expiration time
Source

pub async fn renew_token(&mut self) -> Result<(), RtdbError>

Renews the authentication token.

This method should be called when the current token is about to expire or has expired. It will update the internal authentication state with new credentials.

Source

pub fn token_expired(&self) -> bool

Checks if the current authentication token has expired.

Returns true if the token has expired and needs to be renewed before making further database requests.

Source

pub async fn root(&mut self) -> Result<Node<'_>, RtdbError>

Returns a Node representing the root of the database.

This method will automatically renew the token if it has expired. Use this as the starting point for accessing database paths.

Trait Implementations§

Source§

impl Clone for FirebaseRTDB

Source§

fn clone(&self) -> FirebaseRTDB

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FirebaseRTDB

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,