Struct meilisearch_sdk::indexes::IndexUpdater

pub struct IndexUpdater<'a, Http: HttpClient> {
    pub client: &'a Client<Http>,
    pub uid: String,
    pub primary_key: Option<String>,
}

An IndexUpdater used to update the specifics of an index.

Example

let task = IndexUpdater::new("index_updater", &client)
    .with_primary_key("special_id")
    .execute()
    .await
    .unwrap()
    .wait_for_completion(&client, None, None)
    .await
    .unwrap();

let index = client.get_index("index_updater").await.unwrap();

assert_eq!(index.primary_key, Some("special_id".to_string()));

Fields

client: &'a Client<Http>

uid: String

primary_key: Option<String>

Implementations

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

pub fn new( uid: impl AsRef<str>, client: &Client<Http>, ) -> IndexUpdater<'_, Http>

pub fn with_primary_key( &mut self, primary_key: impl AsRef<str>, ) -> &mut IndexUpdater<'a, Http>

Define the new primary_key to set on the Index.

Example

let task = IndexUpdater::new("index_updater_with_primary_key", &client)
    .with_primary_key("special_id")
    .execute()
    .await
    .unwrap()
    .wait_for_completion(&client, None, None)
    .await
    .unwrap();

let index = client.get_index("index_updater_with_primary_key").await.unwrap();

assert_eq!(index.primary_key, Some("special_id".to_string()));

pub async fn execute(&'a self) -> Result<TaskInfo, Error>

Execute the update of an Index using the IndexUpdater.

Example

let task = IndexUpdater::new("index_updater_execute", &client)
    .with_primary_key("special_id")
    .execute()
    .await
    .unwrap()
    .wait_for_completion(&client, None, None)
    .await
    .unwrap();

let index = client.get_index("index_updater_execute").await.unwrap();

assert_eq!(index.primary_key, Some("special_id".to_string()));

Trait Implementations

impl<'a, Http: HttpClient> AsRef<IndexUpdater<'a, Http>> for IndexUpdater<'a, Http>

fn as_ref(&self) -> &IndexUpdater<'a, Http>

Converts this type into a shared reference of the (usually inferred) input type.

impl<Http: HttpClient> AsRef<str> for IndexUpdater<'_, Http>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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

fn clone(&self) -> IndexUpdater<'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 IndexUpdater<'a, Http>

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

Formats the value using the given formatter.

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.