Create an example showing how to update the Settings

[irevoire]

Pull Request

What does this PR do?

Provide an example that shows how to use the settings.

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

[brunoocasali]

Hey, just left some comments, trying to sane my doubts here!

[brunoocasali]

In line 8, you don't define the "type" but here you defined it, is this a convention or just a non-required thing?

[irevoire]

Oh yes, that's useless!
I copy-pasted some code and forgot to remove it.

But now you talk about it, I think it would be good to show all the types we're using, so when someone looks at the example, he knows instantaneously which function returns what without even looking at the doc.

I'll update my PR thanks 👍

[brunoocasali]

Awesome! This is something I need to be used to, in some communities like in the C# they are going to the full var style (without explicit types). Btw there is a widely used decision regarding the theme?

he knows instantaneously which function returns what without even looking at the doc.

I like this! 👍

[irevoire]

Yep usually in rust you elide all the types you can.
If the compiler is able to infer something let it do it.
Sometimes you even write « half » a type like that:

let chars: Vec<_> = "a string".chars().collect();

Here rust can't guess which kind of data structure you want to create with the .collect method so you need to say it's a Vec, but then you can elide the char because the .chars() method returns an iterator of char 😁

[brunoocasali]

I was reading some "scientific articles"(sarcasm) about unwrap.

My question is, can we use ? here? And can we avoid these calls or I just don't need to bother with that?

[irevoire]

Basically, we can use ? when our function returns a Result.

A little rust lesson just so you know 😁 :

let result = task.try_make_index(&client);
let index = match result {
    Ok(index) => index,
    Err(error) => return Err(error.into()), // `.into` try to convert the error to the type the current function expect
};

This code is equivalent to:

let index = task.try_make_index(&client)?;

---

Ok so now you know 😁

My question is, can we use ? here? And can we avoid these calls or I just don't need to bother with that?

We could make our main return a Result<(), meilisearch_sdk::error::Error> (we can't return anything else than () in a main).
But in an example I THINK, we prefer to write the dumbest code possible to show every little step without any ambiguity.
Now that's my opinion and I can be wrong. There is no standard in rust about that.

Another thing we could do is call expect instead of unwrap. Expect allows us to write a little error message that could be more explicit for the user before unwrapping the error. Something like Can't reach the server..
Like here for example.

[brunoocasali]

Thanks a lot for the detailed explanation you're the best! Now it makes sense to me (no, I'm not an expert yet but it makes sense to me haha).
I agree with you regarding the samples, being the simplest as possible. Experienced users will not how to make it simpler :)

[brunoocasali]

Good job, thanks for your contributions here @irevoire ❤️

[brunoocasali]

bors merge

[bors]

Build succeeded:

• clippy-check
• integration-tests
• readme-check
• wasm-build