Struct Client 

pub struct Client { /* private fields */ }

A connection to an OpenSearch cluster.

Cheap to clone (it shares one connection pool). Construct with Client::connect, optionally adding credentials with Client::basic_auth.

Implementations

impl Client

pub fn connect(url: impl AsRef<str>) -> Result<Self>

Connect to the cluster at url (http or https). This validates the URL and builds the HTTP client; it does not perform any I/O.

pub fn basic_auth( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Attach HTTP basic-auth credentials, applied to every request.

pub async fn get_one<T>( &self, index: &str, hash: &str, id: impl Display, ) -> Result<Option<T>>

where T: DeserializeOwned,

Fetch a single document by id from <index>_<hash>/_doc/<id>. Returns None when the document does not exist.

Until the derive generates Type::get, callers invoke this directly with the document type as T.

impl Client

pub async fn msearch<B: MsearchBundle>(&self, bundle: B) -> Result<B::Output>

Run several typed searches in one _msearch request, returning one typed SearchResponse per search, in slot order. The bundle is a tuple of &Search<T> whose document types may differ:

let (users, orders) = client.msearch((&users_query, &orders_query)).await?;

A slot-level failure fails the whole call with Error::Msearch naming the slot — there are no partial results.

pub async fn msearch_all<T>( &self, searches: &[Search<T>], ) -> Result<Vec<SearchResponse<T>>>

where T: DeserializeOwned,

Run many searches of one document type in a single _msearch request, returning one SearchResponse per search, in order. The heterogeneous (mixed-type) form is Client::msearch.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.