Struct Client 

pub struct Client { /* private fields */ }

Main entry point for interacting with an agtrace workspace.

Implementations

impl Client

pub fn builder() -> ClientBuilder

Create a new ClientBuilder for configuring workspace connection.

This is the recommended way to connect to a workspace as it supports XDG-compliant path resolution and environment variable configuration.

Examples

// Use default path
let client = Client::builder().connect().await?;

// Use custom path
let client = Client::builder()
    .path("/custom/agtrace")
    .connect().await?;

pub async fn connect_default() -> Result<Self>

Connect to the default agtrace workspace.

This is a convenience method that uses XDG-compliant path resolution. It checks (in order):

1. AGTRACE_PATH environment variable
2. System data directory + “agtrace” (e.g., ~/.local/share/agtrace)

Examples

let client = Client::connect_default().await?;

pub async fn connect(path: impl Into<PathBuf>) -> Result<Self>

Connect to an agtrace workspace at the given path.

This is a low-level API. Consider using Client::builder() or Client::connect_default() for better ergonomics and XDG support.

Examples

let client = Client::connect("/custom/agtrace/path").await?;

pub fn sessions(&self) -> SessionClient

Access session operations.

pub fn projects(&self) -> ProjectClient

Access project operations.

pub fn watch(&self) -> WatchClient

Access watch/monitoring operations.

pub fn insights(&self) -> InsightClient

Access insights/analysis operations.

pub fn system(&self) -> SystemClient

Access system operations (init, index, doctor, provider).

pub fn watch_service(&self) -> WatchService

Get the watch service for low-level watch operations. Prefer using client.watch() for most use cases.