Struct PocketBase 

pub struct PocketBase { /* private fields */ }

A PocketBase client for sending requests to a PocketBase instance.

The Debug implementation for this struct redacts sensitive authentication data to prevent accidental exposure in logs.

Example

use std::error::Error;
use pocketbase_rs::PocketBase;
use serde::Deserialize;

#[derive(Deserialize)]
struct Article {
    id: String,
    title: String,
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let mut pb = PocketBase::new("http://localhost:8090");

    pb.collection("users")
        .auth_with_password("YOUR_EMAIL_OR_USERNAME", "YOUR_PASSWORD")
        .await?;

    let article = pb
        .collection("articles")
        .get_one::<Article>("record_id")
        .call()
        .await?;

    println!("Article: {:?}", article);

    Ok(())
}

Implementations

impl PocketBase

pub fn collection(&mut self, collection_name: &'static str) -> Collection<'_>

Creates a new Collection instance for the specified collection name.

This method provides access to operations related to a specific collection in PocketBase. Most interactions with the PocketBase API are performed through the Collection instance returned by this method.

Arguments

• collection_name - The name of the collection to interact with, provided as a static string.

Returns

A Collection instance configured for the specified collection.

Example

let mut pb = PocketBase::new("http://localhost:8090");

pb.collection("users")
    .auth_with_password("YOUR_EMAIL_OR_USERNAME", "YOUR_PASSWORD")
    .await?;

let article = pb
    .collection("articles")
    .get_first_list_item::<Article>()
    .filter("language='en'")
    .call()
    .await?;

Panics

This method will panic if the collection name is empty or contains invalid characters.

impl PocketBase

pub fn new(base_url: &str) -> Self

Creates a new instance of the PocketBase client.

Example

let pb = PocketBase::new("http://localhost:8090");
// Use the client for further operations like authentication or fetching records

Panics

This method will panic if the provided base_url is not a valid URL.

pub fn new_with_client(base_url: &str, client: Client) -> Self

Creates a new PocketBase client with a custom reqwest client.

Example

use std::time::Duration;

let reqwest_client = reqwest::Client::builder()
    .timeout(Duration::from_secs(60))
    .build()
    .expect("Failed to build client");

let pb = PocketBase::new_with_client("http://localhost:8090", reqwest_client);

Panics

This method will panic if the provided base_url is not a valid URL.

pub fn auth_store(&self) -> Option<AuthStore>

Retrieves the current auth store, if available.

Example

let pb = PocketBase::new("http://localhost:8090");

// ...

if let Some(auth_store) = pb.auth_store() {
    println!("Authenticated with token: {}", auth_store.token);
} else {
    println!("Not authenticated");
}

pub fn token(&self) -> Option<String>

Retrieves the current authentication token, if available.

Example

let pb = PocketBase::new("http://localhost:8090");

// ...

if let Some(token) = pb.token() {
    println!("Authenticated with token: {}", token);
} else {
    println!("Not authenticated");
}

pub fn base_url(&self) -> String

Returns the base URL of the PocketBase server.

Example

let pb = PocketBase::new("http://localhost:8090");
assert_eq!(pb.base_url(), "http://localhost:8090".to_string());

Trait Implementations

impl Clone for PocketBase

fn clone(&self) -> PocketBase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PocketBase

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

Formats the value using the given formatter.