Struct KeyBuilder 

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>,
}

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 description = "My little lovely test key".to_string();
let key = KeyBuilder::new()
    .with_description(&description)
    .execute(&client).await.unwrap();

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

Fields

actions: Vec<Action>

description: Option<String>

name: Option<String>

uid: Option<String>

expires_at: Option<OffsetDateTime>

indexes: Vec<String>

Implementations

impl KeyBuilder

pub fn new() -> KeyBuilder

Create a KeyBuilder.

Example

let builder = KeyBuilder::new();

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

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]);

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

Add one action the Key will be able to execute.

Example

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

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

Set the expiration date of the Key.

Example

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);

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

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);

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

Add one index the Key can manage.

Example

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

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

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();

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

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

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();

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

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

Add a 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();

assert_eq!(key.uid, uid);

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

Create a Key from the builder.

Example

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

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

Trait Implementations

impl AsRef<KeyBuilder> for KeyBuilder

fn as_ref(&self) -> &KeyBuilder

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

impl Clone for KeyBuilder

fn clone(&self) -> KeyBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBuilder

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

Formats the value using the given formatter.

impl Default for KeyBuilder

fn default() -> KeyBuilder

Returns the “default value” for a type.

impl Serialize for KeyBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.