Struct meilisearch_sdk::key::KeyUpdater

pub struct KeyUpdater {
    pub description: Option<String>,
    pub name: Option<String>,
    pub key: String,
}

Fields

description: Option<String>

name: Option<String>

key: String

Implementations

impl KeyUpdater

pub fn new(key_or_uid: impl AsRef<str>) -> KeyUpdater

pub fn with_description(&mut self, desc: impl AsRef<str>) -> &mut Self

Update the description of the key.

Example

 let mut new_key = KeyBuilder::new()
    .execute(&client)
    .await
    .unwrap();

let description = "My not so little lovely test key".to_string();
let mut key_update = KeyUpdater::new(new_key)
    .with_description(&description)
    .execute(&client)
    .await
    .unwrap();

pub fn with_name(&mut self, desc: impl AsRef<str>) -> &mut Self

Update the name of the key.

Example

 let mut new_key = KeyBuilder::new()
    .execute(&client)
    .await
    .unwrap();

let name = "lovely key".to_string();

let mut key_update = KeyUpdater::new(new_key)
    .with_name(&name)
    .execute(&client)
    .await
    .unwrap();

pub async fn execute(&self, client: &Client) -> Result<Key, Error>

Update a Key using the KeyUpdater.

Example

let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
let description = "My little lovely test key".to_string();
let key = KeyBuilder::new()
  .execute(&client).await.unwrap();

let mut key_update = KeyUpdater::new(&key.key);
key_update.with_description(&description).execute(&client).await;

assert_eq!(key_update.description, Some(description));

Trait Implementations

impl AsRef<KeyUpdater> for KeyUpdater

fn as_ref(&self) -> &KeyUpdater

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

impl AsRef<str> for KeyUpdater

fn as_ref(&self) -> &str

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

impl Clone for KeyUpdater

fn clone(&self) -> KeyUpdater

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyUpdater

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyUpdater

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for KeyUpdater

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

Serialize this value into the given Serde serializer.