pub struct HyphaeClient { /* private fields */ }Expand description
Reusable bounded client for Hyphae HTTP API version 1.
Implementations§
Source§impl HyphaeClient
impl HyphaeClient
Sourcepub fn builder(base_url: &str) -> Result<ClientBuilder, ClientConfigError>
pub fn builder(base_url: &str) -> Result<ClientBuilder, ClientConfigError>
Sourcepub async fn capabilities(
&self,
) -> Result<ApiResponse<CapabilitiesV1>, ClientError>
pub async fn capabilities( &self, ) -> Result<ApiResponse<CapabilitiesV1>, ClientError>
Reports server capabilities and effective limits.
§Errors
Returns a transport, bound, contract, correlation, or API error.
Sourcepub async fn liveness(&self) -> Result<ApiResponse<HealthV1>, ClientError>
pub async fn liveness(&self) -> Result<ApiResponse<HealthV1>, ClientError>
Sourcepub async fn readiness(&self) -> Result<ApiResponse<HealthV1>, ClientError>
pub async fn readiness(&self) -> Result<ApiResponse<HealthV1>, ClientError>
Sourcepub async fn put(
&self,
request: &PutRequestV1,
) -> Result<ApiResponse<CommitReceiptV1>, ClientError>
pub async fn put( &self, request: &PutRequestV1, ) -> Result<ApiResponse<CommitReceiptV1>, ClientError>
Atomically stores a structured-record batch.
§Errors
Returns a transport, bound, contract, correlation, or API error.
Sourcepub async fn delete(
&self,
request: &DeleteRequestV1,
) -> Result<ApiResponse<CommitReceiptV1>, ClientError>
pub async fn delete( &self, request: &DeleteRequestV1, ) -> Result<ApiResponse<CommitReceiptV1>, ClientError>
Atomically deletes a binary-key batch.
§Errors
Returns a transport, bound, contract, correlation, or API error.
Sourcepub async fn get(
&self,
request: &GetRequestV1,
) -> Result<ApiResponse<GetResponseV1>, ClientError>
pub async fn get( &self, request: &GetRequestV1, ) -> Result<ApiResponse<GetResponseV1>, ClientError>
Gets proven key presence or absence.
§Errors
Returns a transport, bound, contract, correlation, or API error.
Sourcepub async fn query(
&self,
request: &QueryRequestV1,
) -> Result<ApiResponse<QueryResponseV1>, ClientError>
pub async fn query( &self, request: &QueryRequestV1, ) -> Result<ApiResponse<QueryResponseV1>, ClientError>
Executes a deterministic proof-bearing structured query.
§Errors
Returns a transport, bound, contract, correlation, or API error.
Sourcepub async fn download_witness(
&self,
proof: &ProofV1,
) -> Result<ApiResponse<Vec<u8>>, ClientError>
pub async fn download_witness( &self, proof: &ProofV1, ) -> Result<ApiResponse<Vec<u8>>, ClientError>
Downloads the exact snapshot witness referenced by a proof.
§Errors
Rejects a noncanonical reference, transport/bound/API failure, or a digest header that disagrees with the proof.
Trait Implementations§
Source§impl Clone for HyphaeClient
impl Clone for HyphaeClient
Source§fn clone(&self) -> HyphaeClient
fn clone(&self) -> HyphaeClient
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more