Struct meilisearch_sdk::key::KeyBuilder

source ·

pub struct KeyBuilder {
    pub actions: Vec<Action>,
    pub description: Option<String>,
    pub name: Option<String>,
    pub uid: Option<String>,
    pub expires_at: Option<OffsetDateTime>,
    pub indexes: Vec<String>,
}

Expand description

The KeyBuilder is an analog to the Key type but without all the fields managed by Meilisearch. It’s used to create Key.

Example

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

Fields§

§actions: Vec<Action>§description: Option<String>§name: Option<String>§uid: Option<String>§expires_at: Option<OffsetDateTime>§indexes: Vec<String>

Implementations§

source §

impl KeyBuilder

source

pub fn new() -> KeyBuilder

Create a KeyBuilder.

Example

let builder = KeyBuilder::new();

source

pub fn with_actions(
&mut self,
actions: impl IntoIterator<Item = Action>
) -> &mut Self

Declare a set of actions the Key will be able to execute.

Example

let mut builder = KeyBuilder::new();
builder.with_actions(vec![Action::Search, Action::DocumentsAdd]);

source

pub fn with_action(&mut self, action: Action) -> &mut Self

Add one action the Key will be able to execute.

Example

let mut builder = KeyBuilder::new();
builder.with_action(Action::DocumentsAdd);

source

pub fn with_expires_at(&mut self, expires_at: OffsetDateTime) -> &mut Self

Set the expiration date of the Key.

Example

use time::{OffsetDateTime, Duration};
let mut builder = KeyBuilder::new();
// create a key that expires in two weeks from now
builder.with_expires_at(OffsetDateTime::now_utc() + Duration::WEEK * 2);

source

pub fn with_indexes(
&mut self,
indexes: impl IntoIterator<Item = impl AsRef<str>>
) -> &mut Self

Set the indexes the Key can manage.

Example

let mut key = KeyBuilder::new()
  .with_indexes(vec!["test", "movies"])
  .execute(&client)
  .await
  .unwrap();

assert_eq!(vec!["test", "movies"], key.indexes);

source

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

Add one index the Key can manage.

Example

let mut builder = KeyBuilder::new();
builder.with_index("test");

source

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

Add a description to the key.

Example

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

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

source

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

Add a name to the key.

Example

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

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

source

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

Add an uid to the key.

Example

 let uid = "93bcd7fb-2196-4fd9-acb7-3fca8a96e78f".to_string();

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

source

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

Create a Key from the builder.

Example

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