mirror of https://github.com/spacedriveapp/spacedrive.git synced 2025-12-11 20:15:30 +01:00

History

Jamie Pine 651e9bae46 Refactor and improve code clarity across multiple files

- Simplified the timeout handling in `is_daemon_running` for better readability.
- Updated type definitions in the macOS Tauri library for clarity.
- Reformatted JSON configuration for better structure and readability.
- Changed function signatures in `files.rs` and `server.rs` to use `Path` instead of `PathBuf` for consistency.
- Enhanced error handling and argument passing in various functions for improved clarity.
- Added `#[allow(dead_code)]` annotations to unused functions in several modules to suppress warnings.
- Improved the display string methods in `volume.rs` and `pairing/types.rs` for better performance and clarity.

2025-12-10 15:08:46 -08:00

examples

cargo format

2025-12-03 15:56:27 -08:00

src

Refactor and improve code clarity across multiple files

2025-12-10 15:08:46 -08:00

Cargo.toml

…

README.md

…

test.sh

…

README.md

sd-client

Rust client library for connecting to the Spacedrive daemon.

Features

Unix socket communication with Spacedrive core
Type-safe query and action execution
Media file listing queries
Thumbnail URL construction
Smart thumbnail variant selection

Usage

use sd_client::{SpacedriveClient, SdPath};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Create client
    let mut client = SpacedriveClient::new(
        "/path/to/daemon.sock".into(),
        "http://localhost:54321".into(),
    );

    // Set library context
    client.set_library("library-uuid".to_string());

    // Query media files
    let files = client.media_listing(
        SdPath::Physical {
            device_id: "local".to_string(),
            path: "/Users/you/Photos".to_string(),
        },
        Some(1000),
    ).await?;

    // Get thumbnail URLs
    for file in files {
        if let Some(content_id) = file.content_identity {
            if let Some(thumb) = client.select_best_thumbnail(&file.sidecars, 256.0) {
                let url = client.thumbnail_url(
                    &content_id.uuid,
                    &thumb.variant,
                    &thumb.format,
                );
                println!("{}: {}", file.name, url);
            }
        }
    }

    Ok(())
}

Example

Run the test connection example:

export SD_LIBRARY_ID="your-library-uuid"
export SD_SOCKET_PATH="$HOME/.spacedrive/daemon.sock"  # optional
export SD_HTTP_URL="http://127.0.0.1:54321"            # optional

cargo run --example test_connection

API

SpacedriveClient

new(socket_path, http_base_url) - Create a new client
set_library(library_id) - Set the current library context
execute(wire_method, input) - Execute a query or action
media_listing(path, limit) - Query media files
thumbnail_url(content_uuid, variant, format) - Construct thumbnail URL
select_best_thumbnail(sidecars, target_size) - Pick optimal thumbnail variant

Types

File - File metadata with content identity and sidecars
ContentIdentity - Content hash and UUID for deduplication
Sidecar - Generated derivatives (thumbnails, proxies, etc.)
SdPath - Location-independent file reference
ImageMediaData - Image-specific metadata (dimensions, date taken)
VideoMediaData - Video-specific metadata (dimensions, duration)