Skip to main content

RpcClient

Struct RpcClient 

Source
pub struct RpcClient { /* private fields */ }
Expand description

One connection to a Vectorizer RPC server.

Implementations§

Source§

impl RpcClient

Source

pub async fn connect_url(url: &str) -> Result<Self>

Convenience: parse a vectorizer://host[:port] URL and dial.

Accepts every form documented at crate::rpc::endpoint::parse_endpoint:

  • vectorizer://host:port → RPC on the given port.
  • vectorizer://host → RPC on the default port 15503.
  • host:port (no scheme) → RPC.
  • http(s)://... → returns RpcClientError::Server with a clear message asking the caller to use the HTTP client instead. The SDK ships the http Cargo feature for that path; an http:// URL is not a transport an RPC client can speak.
Source

pub async fn connect(addr: impl ToSocketAddrs) -> Result<Self>

Open a TCP connection to addr (which must be host:port) and start the background reader task. Does NOT send HELLO — callers MUST call Self::hello before any data-plane command, or the server will reject it.

Source

pub async fn hello(&self, payload: HelloPayload) -> Result<HelloResponse>

Issue the HELLO handshake. Must be the first call on a fresh connection. Returns the server’s capability list and auth flags.

Source

pub async fn ping(&self) -> Result<String>

Health check. The server treats PING as auth-exempt so this works even before HELLO; the typed wrapper still validates the response shape.

Source

pub async fn call( &self, command: impl Into<String>, args: Vec<VectorizerValue>, ) -> Result<VectorizerValue>

Generic call dispatcher. Most callers should use a typed wrapper from crate::rpc::commands instead.

Source

pub fn is_authenticated(&self) -> bool

Returns true once HELLO has succeeded on this connection.

Source

pub fn close(self)

Close the connection. Aborts the reader task; in-flight calls receive ConnectionClosed.

Source§

impl RpcClient

Source

pub async fn list_collections(&self) -> Result<Vec<String>>

collections.list — return every collection name visible to the authenticated principal.

Source

pub async fn get_collection_info(&self, name: &str) -> Result<CollectionInfo>

collections.get_info — return metadata for one collection.

Source

pub async fn get_vector( &self, collection: &str, vector_id: &str, ) -> Result<VectorizerValue>

vectors.get — fetch one vector by id. Returns the raw VectorizerValue::Map so callers can read whichever fields they care about (id, data, payload, document_id).

Source

pub async fn search_basic( &self, collection: &str, query: &str, limit: usize, ) -> Result<Vec<SearchHit>>

search.basic — search collection for query and return up to limit hits sorted by descending similarity.

Trait Implementations§

Source§

impl Drop for RpcClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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