Struct meilisearch_sdk::key::Key

pub struct Key {
    pub actions: Vec<Action>,
    pub created_at: OffsetDateTime,
    pub description: Option<String>,
    pub name: Option<String>,
    pub expires_at: Option<OffsetDateTime>,
    pub indexes: Vec<String>,
    pub key: String,
    pub uid: String,
    pub updated_at: OffsetDateTime,
}

Represents a meilisearch key.

You can get a Key from the Client::get_key method, or you can create a Key with the KeyBuilder::new or Client::create_key methods.

Fields

actions: Vec<Action>

created_at: OffsetDateTime

description: Option<String>

name: Option<String>

expires_at: Option<OffsetDateTime>

indexes: Vec<String>

key: String

uid: String

updated_at: OffsetDateTime

Implementations

impl Key

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

Update the description of the Key.

Example

let description = "My not so little lovely test key".to_string();
let mut key = KeyBuilder::new()
    .with_action(Action::DocumentsAdd)
    .with_index("*")
    .with_description(&description)
    .execute(&client).await.unwrap();

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

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

Update the name of the Key.

Example

let name = "lovely key".to_string();
let mut key = KeyBuilder::new()
    .with_action(Action::DocumentsAdd)
    .with_index("*")
    .execute(&client)
    .await
    .unwrap();

key.with_name(&name);

assert_eq!(key.name, Some(name));

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

Update the Key.

Example

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

let description = "My not so little lovely test key".to_string();
key.with_description(&description);

let key = key.update(&client).await.unwrap();

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

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

Delete the Key.

Example

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

client.delete_key(key).await.unwrap();

Trait Implementations

impl AsRef<Key> for Key

fn as_ref(&self) -> &Key

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

impl AsRef<str> for Key

fn as_ref(&self) -> &str

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

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Key

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

where __S: Serializer,

Serialize this value into the given Serde serializer.