Struct DatabaseReference 

pub struct DatabaseReference { /* private fields */ }

Implementations

impl DatabaseReference

pub fn child(&self, relative: &str) -> DatabaseResult<DatabaseReference>

pub fn parent(&self) -> Option<DatabaseReference>

Returns the parent of this reference, mirroring ref.parent in the JS SDK.

pub fn root(&self) -> DatabaseReference

Returns the root of the database, mirroring ref.root in the JS SDK.

pub async fn set(&self, value: Value) -> DatabaseResult<()>

pub fn query(&self) -> DatabaseQuery

Creates a query anchored at this reference, mirroring the JS query() helper.

pub fn order_by_child(&self, path: &str) -> DatabaseResult<DatabaseQuery>

Returns a query ordered by the provided child path, mirroring orderByChild().

pub fn order_by_key(&self) -> DatabaseResult<DatabaseQuery>

Returns a query ordered by key, mirroring orderByKey().

pub fn order_by_value(&self) -> DatabaseResult<DatabaseQuery>

Returns a query ordered by value, mirroring orderByValue().

pub fn order_by_priority(&self) -> DatabaseResult<DatabaseQuery>

Returns a query ordered by priority, mirroring orderByPriority().

pub async fn on_value<F>( &self, callback: F, ) -> DatabaseResult<ListenerRegistration>

where F: Fn(Result<DataSnapshot, DatabaseError>) + Send + Sync + 'static,

Registers a value listener for this reference, mirroring onValue().

pub async fn on_child_added<F>( &self, callback: F, ) -> DatabaseResult<ListenerRegistration>

where F: Fn(Result<ChildEvent, DatabaseError>) + Send + Sync + 'static,

Registers an onChildAdded listener, mirroring the JS SDK.

pub async fn on_child_changed<F>( &self, callback: F, ) -> DatabaseResult<ListenerRegistration>

where F: Fn(Result<ChildEvent, DatabaseError>) + Send + Sync + 'static,

Registers an onChildChanged listener, mirroring the JS SDK.

pub async fn on_child_removed<F>( &self, callback: F, ) -> DatabaseResult<ListenerRegistration>

where F: Fn(Result<ChildEvent, DatabaseError>) + Send + Sync + 'static,

Registers an onChildRemoved listener, mirroring the JS SDK.

pub fn on_disconnect(&self) -> OnDisconnect

Returns a handle for configuring operations to run when the client disconnects.

pub async fn run_transaction<F>( &self, update: F, ) -> DatabaseResult<TransactionResult>

where F: FnMut(Value) -> Option<Value>,

Runs a transaction on this reference. The closure receives the current value and may return Some(next) to commit or None to abort, mirroring the JS SDK contract.

pub async fn update(&self, updates: Map<String, Value>) -> DatabaseResult<()>

Applies the provided partial updates to the current location using a single REST PATCH call when available.

Each key represents a relative child path (e.g. "profile/name"). The method rejects empty keys to mirror the JS SDK behaviour.

pub async fn get(&self) -> DatabaseResult<Value>

pub async fn remove(&self) -> DatabaseResult<()>

Deletes the value at this location using the backend’s DELETE support.

pub async fn set_with_priority<V, P>( &self, value: V, priority: P, ) -> DatabaseResult<()>

where V: Into<Value>, P: Into<Value>,

Writes the provided value together with its priority, mirroring setWithPriority() in packages/database/src/api/Reference_impl.ts.

pub async fn set_priority<P>(&self, priority: P) -> DatabaseResult<()>

where P: Into<Value>,

Updates the priority for this location, mirroring setPriority() in the JS SDK.

pub async fn push(&self) -> DatabaseResult<DatabaseReference>

Creates a child location with an auto-generated key, mirroring push() from the JS SDK.

Port of push() in packages/database/src/api/Reference_impl.ts.

Examples

let new_message = messages.push_with_value(json!({ "text": "hi" })).await.expected("Failed to push message");
assert!(new_message.key().is_some());

pub async fn push_with_value<V>( &self, value: V, ) -> DatabaseResult<DatabaseReference>

where V: Into<Value>,

Creates a child location with an auto-generated key and writes the provided value.

Mirrors the push(ref, value) overload from packages/database/src/api/Reference_impl.ts.

pub fn key(&self) -> Option<&str>

Returns the last path segment (the key) for this reference, mirroring ref.key in the JS SDK.

pub fn path(&self) -> String

Trait Implementations

impl Clone for DatabaseReference

fn clone(&self) -> DatabaseReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseReference

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

Formats the value using the given formatter.