Struct KorrosyncServiceRedb 

pub struct KorrosyncServiceRedb { /* private fields */ }

Redb-based implementation of KoReader synchronization service.

This service provides a high-level API for user authentication and reading progress synchronization using an embedded redb database with transactional guarantees.

Implementations

impl KorrosyncServiceRedb

pub fn new(path: impl AsRef<Path>) -> Result<KorrosyncServiceRedb, ServiceError>

Creates a new KorrosyncServiceRedb with a database at the specified path.

This method initializes the embedded redb database and creates the required tables if they don’t already exist. If the database file already exists, it will be opened and reused.

Parent directories are created automatically if they don’t exist, so you can safely provide paths like "data/db/korrosync.db" without pre-creating the folders.

Arguments

• path - Path to the database file (will be created if it doesn’t exist)

Returns

Returns a new KorrosyncServiceRedb instance ready for use.

Errors

Returns an error if:

• Parent directories cannot be created (permission issues, invalid path)
• The database file cannot be created or opened
• There are permission issues accessing the file or directories
• The database is corrupted or incompatible

Examples

use korrosync::service::db::KorrosyncServiceRedb;

// Create a service with a simple database file
let service = KorrosyncServiceRedb::new("korrosync.db")?;

Trait Implementations

impl KorrosyncService for KorrosyncServiceRedb

fn get_user(&self, name: String) -> Result<Option<User>, ServiceError>

Retrieves a user by username from the database.

Arguments

• name - The username to look up

Returns

• Ok(Some(user)) - User found with the given username
• Ok(None) - No user exists with the given username

Example

use korrosync::service::db::{KorrosyncService, KorrosyncServiceRedb};

let service = KorrosyncServiceRedb::new("korrosync.db")?;

match service.get_user("alice".into())? {
    Some(user) => println!("Found user: {}", user.username()),
    None => println!("User not found"),
}

fn create_or_update_user(&self, user: User) -> Result<User, ServiceError>

Adds a new user or updates an existing user in the database.

Arguments

• user - Reference to the user to add or update

Example

use korrosync::service::db::{KorrosyncService, KorrosyncServiceRedb};
use korrosync::model::User;

let service = KorrosyncServiceRedb::new("korrosync.db")?;
let user = User::new("alice", "secure_password")?;

service.create_or_update_user(user)?;
println!("User added successfully");

fn update_progress( &self, user: String, document: String, progress: Progress, ) -> Result<(String, u64), ServiceError>

Updates or creates reading progress for a user’s document.

This method stores the reading progress for a specific user and document combination. If progress already exists for this combination, it will be overwritten with the new data. The operation is atomic and transactional.

Arguments

• user - The username of the user
• document - The document identifier (typically filename or path)
• progress - The progress information to store

Returns

Returns a tuple containing:

• The document identifier (echoed back)
• The timestamp from the progress record

Example

use korrosync::service::db::{KorrosyncService, KorrosyncServiceRedb};
use korrosync::model::Progress;

let service = KorrosyncServiceRedb::new("korrosync.db")?;

let progress = Progress {
    device_id: "device-123".to_string(),
    device: "Kindle".to_string(),
    percentage: 45.5,
    progress: "Page 91 of 200".to_string(),
    timestamp: 1609459200000,
};

let (doc, ts) = service.update_progress("alice".into(), "book.epub".into(), progress)?;
println!("Updated progress for {} at timestamp {}", doc, ts);

fn get_progress( &self, user: String, document: String, ) -> Result<Option<Progress>, ServiceError>

Retrieves reading progress for a specific user and document.

Arguments

• user - The username of the user
• document - The document identifier to look up

Returns

Returns the Progress information if found.

Example

use korrosync::service::db::{KorrosyncService, KorrosyncServiceRedb};

let service = KorrosyncServiceRedb::new("korrosync.db")?;

match service.get_progress("alice".to_string(), "book.epub".to_string()) {
    Ok(Some(progress)) => {
        println!("Progress: {}% on device {}",
                 progress.percentage, progress.device);
    }
    Ok(None) => println!("No progress found"),
    Err(e) => println!("Unexpected error: {}", e),
}