Skip to main content

HyphaeClient

Struct HyphaeClient

pub struct HyphaeClient { /* private fields */ }

Expand description

Reusable bounded client for Hyphae HTTP API version 1.

Implementations§

impl HyphaeClient

pub fn builder(base_url: &str) -> Result<ClientBuilder, ClientConfigError>

Starts a client builder for one root origin.

§Errors

Returns a base-URL validation error.

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.

pub async fn liveness(&self) -> Result<ApiResponse<HealthV1>, ClientError>

Reports process liveness.

§Errors

Returns a transport, bound, contract, correlation, or API error.

pub async fn readiness(&self) -> Result<ApiResponse<HealthV1>, ClientError>

Reports engine readiness.

§Errors

Returns a transport, bound, contract, correlation, or API error.

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.

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.

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.

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.

pub async fn define_vector_space( &self, request: &DefineVectorSpaceRequestV1, ) -> Result<ApiResponse<CommitReceiptV1>, ClientError>

Defines or exactly reuses one immutable durable vector space.

§Errors

Returns a transport, bound, contract, correlation, or API error.

pub async fn put_vectors( &self, request: &PutVectorsRequestV1, ) -> Result<ApiResponse<CommitReceiptV1>, ClientError>

Atomically stores one durable vector batch.

§Errors

Returns a transport, bound, contract, correlation, or API error.

pub async fn delete_vectors( &self, request: &DeleteVectorsRequestV1, ) -> Result<ApiResponse<CommitReceiptV1>, ClientError>

Atomically deletes one durable vector batch.

§Errors

Returns a transport, bound, contract, correlation, or API error.

pub async fn retrieve_exact( &self, request: &ExactRetrievalRequestV1, ) -> Result<ApiResponse<ExactRetrievalResponseV1>, ClientError>

Executes proof-bearing exact durable vector retrieval.

§Errors

Returns a transport, bound, contract, correlation, or API error.

pub async fn define_lexical_index( &self, request: &DefineLexicalIndexRequestV1, ) -> Result<ApiResponse<CommitReceiptV1>, ClientError>

Defines or exactly reuses one immutable provider-free lexical index.

§Errors

Returns a transport, bound, contract, correlation, or API error.

pub async fn retrieve_lexical( &self, request: &LexicalRetrievalRequestV1, ) -> Result<ApiResponse<LexicalRetrievalResponseV1>, ClientError>

Executes proof-bearing provider-free lexical retrieval.

§Errors

Returns a transport, bound, contract, correlation, or API error.

pub async fn retrieve_hybrid( &self, request: &HybridRetrievalRequestV1, ) -> Result<ApiResponse<HybridRetrievalResponseV1>, ClientError>

Executes proof-bearing deterministic hybrid retrieval.

§Errors

Returns a transport, bound, contract, correlation, or API error.

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.

pub async fn download_retrieval_witness( &self, proof: &RetrievalProofV1, ) -> Result<ApiResponse<Vec<u8>>, ClientError>

Downloads the exact snapshot witness referenced by a retrieval proof.

§Errors

Rejects a noncanonical reference, transport/bound/API failure, or a digest header that disagrees with the proof.

Trait Implementations§

impl Clone for HyphaeClient

fn clone(&self) -> HyphaeClient

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for HyphaeClient

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !Freeze for HyphaeClient

impl !RefUnwindSafe for HyphaeClient

impl !UnwindSafe for HyphaeClient

impl Send for HyphaeClient

impl Sync for HyphaeClient

impl Unpin for HyphaeClient

impl UnsafeUnpin for HyphaeClient

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more