Struct AdminUser

pub struct AdminUser(/* private fields */);

The AdminUser guard can be used analogously to User. It will restrict content, so that it can be viewed by admins only.

#[get("/admin-panel")]
fn admin_panel(user: AdminUser) -> String {
   format!("Hello {}.", user.email())
}

Methods from Deref<Target = User>

pub fn set_password(&mut self, new: &str) -> Result<(), Box<dyn Error>>

This method allows to reset the password of a user. In order for the new password to be saved, it must be passed to a Users instance. This function is meant for cases where the user lost their password. In case the user is authenticated, you can change it more easily with change_password. This function will fail in case the password is not secure enough.

use rocket::{State, post};
use rocket_auth2::{Error, Users, User};
#[post("/reset-password/<new_password>")]
async fn reset_password(mut user: User, users: &State<Users>, new_password: String) -> Result<(), Error> {
    user.set_password(&new_password);
    users.modify(&user).await?;
    Ok(())
}

pub fn compare_password(&self, password: &str) -> Result<bool, Error>

Compares the password of the currently authenticated user with a another password. Useful for checking password before resetting email/password. To avoid bruteforcing this function should not be directly accessible from a route. Additionally, it is good to implement rate limiting on routes using this function.

pub fn id(&self) -> i32

This is an accessor function for the private id field. This field is private, so that it is not modified by accident when updating a user.

use rocket::{State, get};
use rocket_auth2::{Error, User};
#[get("/show-my-id")]
fn show_my_id(user: User) -> String {
    format!("Your user_id is: {}", user.id())
}

pub fn email(&self) -> &str

This is an accessor field for the private email field. This field is private so an email cannot be updated without checking whether it is valid.

use rocket::{State, get};
use rocket_auth2::{Error, User};
#[get("/show-my-email")]
fn show_my_email(user: User) -> String {
    format!("Your user_id is: {}", user.email())
}

pub fn set_email(&mut self, email: String) -> Result<()>

This functions allows to easily modify the email of a user. In case the input is not a valid email, it will return an error. In case the user corresponds to the authenticated client, it’s easier to use Auth::change_email.

#[get("/set-email/<email>")]
async fn set_email(email: String, auth: Auth<'_>) -> Result<String, Error> {
    let mut user = auth.get_user().await.unwrap();
    user.set_email(email)?;
    auth.users.modify(&user).await?;
    Ok("Your user email was changed".into())
}

pub fn is<Q>(&self, role: &Q) -> bool

where Role: Borrow<Q>, Q: Hash + Eq + ?Sized,

Trait Implementations

impl Clone for AdminUser

fn clone(&self) -> AdminUser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdminUser

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

Formats the value using the given formatter.

impl Deref for AdminUser

type Target = User

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for AdminUser

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for AdminUser

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'r> FromRequest<'r> for AdminUser

type Error = Error

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0>, ) -> Pin<Box<dyn Future<Output = Outcome<AdminUser, Error>> + Send + 'async_trait>>

where 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata.

impl PartialEq for AdminUser

fn eq(&self, other: &AdminUser) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AdminUser

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<User> for AdminUser

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: User) -> Result<Self>

Performs the conversion.

impl Eq for AdminUser

impl StructuralPartialEq for AdminUser