Struct Client 

pub struct Client { /* private fields */ }

An optional local service connection, trusting the configured local operator. Construction performs no I/O. Each operation opens one bounded connection.

Implementations

impl Client

pub fn new(address: SocketAddr, token: String) -> Result<Self, Error>

pub fn status(&self) -> Result<ServiceStatus, Error>

Typed service status reported by the local operator, without verifying its claims.

pub fn status_json(&self) -> Result<Value, Error>

Raw status JSON reported by the local operator, without verifying its claims.

pub fn record(&self, txid: Txid) -> Result<Option<ArchivedRecord>, Error>

Read locally archived data. None means HTTP 404 (not locally available), not proof that a record does not exist. Authentication and other failures remain errors. Only the receipt’s TXID is compared with the requested ID.

The chain is unknown here: reveal decoding, TXID/witness recomputation, inclusion and URMA verification belong to independent admission through Engine::admit_record. Deserialization does not establish those claims.

pub fn object_status(&self, root: Txid) -> Result<Option<ObjectStatus>, Error>

Read object availability reported by the configured local operator. These are operator data, not independently verified chain evidence. Selected member count is independent of local retention: either count may exceed the other, but both must be within a nonzero member total. None means only that no completed object is recorded locally (HTTP 404), not global absence. Root/count sanity checks establish no crypto claims.

pub fn set_pin(&self, root: Txid, pin: bool) -> Result<PinReceipt, Error>

Request a local pin or unpin and read the operator’s acknowledgement at its commit point. This is not cryptographic evidence or a promise of future availability, chain selection or pin state. Only HTTP 200 with the requested root and pin value succeeds. No automatic retry occurs: the operation may already have committed before a socket failure.

pub fn prune_cache(&self) -> Result<PruneReceipt, Error>

Request explicit local cache pruning and read the operator’s removal count. This acknowledgement is not cryptographic evidence or a promise of future cache contents. Only HTTP 200 succeeds. No automatic retry occurs, including when a socket failure leaves the commit outcome unknown.

pub fn overlay_omissions(&self) -> Result<Vec<Omission>, Error>

Recorded peer omissions; HTTP 404 is Error::Invalid("overlay disabled").

pub fn overlay_book(&self) -> Result<Vec<BookEntry>, Error>

The peer book’s routing hints; HTTP 404 is Error::Invalid("overlay disabled").

pub fn wire_page( &self, cursor: Option<&WireCursor>, limit: u32, ) -> Result<WirePage, Error>

Read one bounded page of Wire records from the configured local operator. Entry parsing checks data consistency, not authorship or chain inclusion. Selected records and scanned coverage remain separate; next == None ends only the local result set and does not establish chain completeness. A snapshot is opaque. HTTP 409 returns Error::Busy: discard the partial traversal and explicitly restart. No paging, retry or readback is automatic.

pub fn register_names( &self, genesis: Txid, block: ChainPoint, ) -> Result<NamesStatus, Error>

Register an explicitly located genesis with the local operator. This is a local index acknowledgement, not independent evidence or permanent state. HTTP 409 remains Busy; a possibly committed operation is never retried.

pub fn names_step(&self, genesis: Txid) -> Result<NamesStep, Error>

Request one local Names step and read operator outcomes. No independent proof, automatic stepping, retry or readback; HTTP 409 remains Busy.

pub fn names_status(&self, genesis: Txid) -> Result<Option<NamesStatus>, Error>

Read operator Names progress. None means only locally unregistered (404), not global absence. No stepping or retry; HTTP 409 remains Busy.

pub fn names_resolve( &self, genesis: Txid, name: &Name, ) -> Result<NamesResolution, Error>

Read local operator resolution for a canonical name, not independent ownership evidence or permanent state. No stepping/retry; 409 remains Busy.

pub fn names_view( &self, genesis: Txid, cursor: Option<&NamesCursor>, limit: u32, ) -> Result<NamesPage, Error>

Read one local operator Names page, not independent chain/registry evidence. The consumer checks its expected chain and metadata consistency across pages. No automatic paging, stepping or retry; 409 remains Busy and ends traversal. Absent continuation ends only the local snapshot, not chain completeness.

Trait Implementations

impl RecordSource for Client

Fetch data only from the explicitly configured local operator endpoint. This adapter performs no peer or network discovery. The receiving engine independently verifies the package against its own selected headers.

fn fetch(&self, txid: Txid) -> Result<Option<RecordPackage>, Error>