Struct FloraServiceClient 

pub struct FloraServiceClient<Stub = Channel<FloraServiceRequest, FloraServiceResponse>>(/* private fields */);

The client stub that makes RPC calls to the server. All request methods return Futures.

Implementations

impl FloraServiceClient

pub fn new<T>( config: Config, transport: T, ) -> NewClient<Self, RequestDispatch<FloraServiceRequest, FloraServiceResponse, T>>

where T: Transport<ClientMessage<FloraServiceRequest>, Response<FloraServiceResponse>>,

Returns a new client stub that sends requests over the given transport.

impl<Stub> FloraServiceClient<Stub>

where Stub: Stub<Req = FloraServiceRequest, Resp = FloraServiceResponse>,

pub fn ping( &self, ctx: Context, ) -> impl Future<Output = Result<String, RpcError>> + '_

Pings the server. Can be used to check the server is alive.

A server is expected to respond with PONG.

pub fn add_record( &self, ctx: Context, record_params: RecordParams, ) -> impl Future<Output = Result<OmryResult<RecordId>, RpcError>> + '_

Adds a record to flora.

pub fn add_many_records( &self, ctx: Context, records: Vec<RecordParams>, ) -> impl Future<Output = Result<OmryResult<RecordIds>, RpcError>> + '_

Adds multiple records to flora.

pub fn count( &self, ctx: Context, ) -> impl Future<Output = Result<OmryResult<i64>, RpcError>> + '_

Returns the count of records in the database.

pub fn get_records( &self, ctx: Context, record_ids: RecordIds, ) -> impl Future<Output = Result<OmryResult<Arc<Vec<Record>>>, RpcError>> + '_

Gets records matching the given IDs.

pub fn get_all_records( &self, ctx: Context, ) -> impl Future<Output = Result<OmryResult<Arc<Vec<Record>>>, RpcError>> + '_

Gets all records in the Omry database.

pub fn get_all_records_meta( &self, ctx: Context, ) -> impl Future<Output = Result<OmryResult<Vec<RecordMeta>>, RpcError>> + '_

Gets the metadata (all fields except document) for all records in the Omry database.

pub fn delete_record( &self, ctx: Context, record_id: RecordId, ) -> impl Future<Output = Result<OmryResult<usize>, RpcError>> + '_

Deletes record with the given ID.

pub fn search( &self, ctx: Context, search_params: SearchParametersWrapper, ) -> impl Future<Output = Result<OmryResult<SearchResponse>, RpcError>> + '_

Searches Omry’s Typesense instance.

pub fn version( &self, ctx: Context, ) -> impl Future<Output = Result<OmryResult<String>, RpcError>> + '_

Returns the version of the Omry service.

Trait Implementations

impl<Stub: Clone> Clone for FloraServiceClient<Stub>

fn clone(&self) -> FloraServiceClient<Stub>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Stub: Debug> Debug for FloraServiceClient<Stub>

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

Formats the value using the given formatter.

impl<Stub> From<Stub> for FloraServiceClient<Stub>

where Stub: Stub<Req = FloraServiceRequest, Resp = FloraServiceResponse>,

fn from(stub: Stub) -> Self

Returns a new client stub that sends requests over the given transport.