Struct NodeClient 

pub struct NodeClient { /* private fields */ }

A client for communicating with a panproto node’s XRPC endpoints.

Implementations

impl NodeClient

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

Create a new client for a panproto node.

pub fn with_token(self, token: &str) -> Self

Set the bearer token for authenticated operations.

pub fn from_url(url: &str) -> Result<Self, XrpcError>

Parse a panproto://did/repo URL into (base_url, did, repo).

Also accepts the legacy cospan:// prefix for backward compatibility. The base URL defaults to https://node.panproto.dev unless overridden by the PANPROTO_NODE_URL environment variable (falls back to COSPAN_NODE_URL for backward compatibility).

Errors

Returns XrpcError::InvalidUrl if the URL format is invalid.

pub async fn get_object(&self, id: &ObjectId) -> Result<Object, XrpcError>

Fetch a content-addressed object by ID. Returns msgpack-encoded bytes.

Errors

Returns XrpcError on network or decode failure.

pub async fn get_ref( &self, ref_name: &str, ) -> Result<Option<ObjectId>, XrpcError>

Resolve a named ref to an object ID.

Errors

Returns XrpcError on network failure or if the ref doesn’t exist.

pub async fn list_refs(&self) -> Result<Vec<(String, ObjectId)>, XrpcError>

List all refs in the repository.

Errors

Returns XrpcError on network failure.

pub async fn get_head(&self) -> Result<HeadState, XrpcError>

Get the HEAD state of the repository.

Errors

Returns XrpcError on network failure.

pub async fn get_repo_info(&self) -> Result<RepoInfo, XrpcError>

Get repository metadata.

Errors

Returns XrpcError on network failure.

pub async fn list_commits( &self, git_ref: Option<&str>, limit: Option<u32>, ) -> Result<ListCommitsResult, XrpcError>

List commits reachable from a ref (default: HEAD).

Returns commits in topological + time order (newest first), up to limit entries (default 50, max 500 on the server).

Errors

Returns XrpcError on network failure or parse error.

pub async fn diff_commits( &self, from: &str, to: &str, context_lines: Option<u32>, ) -> Result<DiffCommitsResult, XrpcError>

Compute the diff between two commits.

from and to are full hex object IDs. context_lines controls how many surrounding lines to include in text hunks (default 3 on the server).

Errors

Returns XrpcError on network failure or parse error.

pub async fn put_object(&self, object: &Object) -> Result<ObjectId, XrpcError>

Store a content-addressed object on the node.

Errors

Returns XrpcError::AuthRequired if no token is set. Returns XrpcError on network or encode failure.

pub async fn set_ref( &self, ref_name: &str, old_target: Option<&ObjectId>, new_target: &ObjectId, protocol: &str, commit_count: u64, ) -> Result<(), XrpcError>

Update a named ref on the node.

Errors

Returns XrpcError::AuthRequired if no token is set.

pub async fn negotiate( &self, have: &[ObjectId], want: &[String], ) -> Result<NegotiateResult, XrpcError>

Run have/want negotiation for efficient object transfer.

Sends the local object IDs we have and the ref names we want. Returns the object IDs the other side needs.

Errors

Returns XrpcError on network failure.

pub async fn push<S: Store>(&self, store: &S) -> Result<PushResult, XrpcError>

Push local objects and refs to the remote node.

Flow: list local refs, negotiate, putObject for each needed object, setRef for each ref.

Errors

Returns XrpcError on any failure in the push pipeline.

pub async fn pull<S: Store>( &self, store: &mut S, ) -> Result<PullResult, XrpcError>

Pull remote objects and refs into the local store.

Flow: listRefs on remote, negotiate, getObject for each needed object, store locally, update local refs.

Errors

Returns XrpcError on any failure in the pull pipeline.

Trait Implementations

impl Clone for NodeClient

fn clone(&self) -> NodeClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeClient

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

Formats the value using the given formatter.