Struct meilisearch_sdk::documents::DocumentQuery

pub struct DocumentQuery<'a, Http: HttpClient> {
    pub index: &'a Index<Http>,
    pub fields: Option<Vec<&'a str>>,
}

Fields

index: &'a Index<Http>

fields: Option<Vec<&'a str>>

The fields that should appear in the documents. By default, all of the fields are present.

Implementations

impl<'a, Http: HttpClient> DocumentQuery<'a, Http>

pub fn new(index: &Index<Http>) -> DocumentQuery<'_, Http>

pub fn with_fields( &mut self, fields: impl IntoIterator<Item = &'a str>, ) -> &mut DocumentQuery<'a, Http>

Specify the fields to return in the document.

Example

let index = client.index("document_query_with_fields");
let mut document_query = DocumentQuery::new(&index);

document_query.with_fields(["title"]);

pub async fn execute<T: DeserializeOwned + 'static + Send + Sync>( &self, document_id: &str, ) -> Result<T, Error>

Execute the get document query.

Example

#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct MyObject {
    id: String,
    kind: String,
}

#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct MyObjectReduced {
    id: String,
}

let document = DocumentQuery::new(&index).with_fields(["id"])
    .execute::<MyObjectReduced>("1")
    .await
    .unwrap();

assert_eq!(
    document,
    MyObjectReduced { id: "1".to_string() }
);

Trait Implementations

impl<'a, Http: Clone + HttpClient> Clone for DocumentQuery<'a, Http>

fn clone(&self) -> DocumentQuery<'a, Http>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Http: Debug + HttpClient> Debug for DocumentQuery<'a, Http>

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

Formats the value using the given formatter.

impl<'a, Http: HttpClient> Serialize for DocumentQuery<'a, Http>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.