Struct rocket_auth::User

pub struct User {
    pub is_admin: bool,
    // some fields omitted
}

The User guard can be used to restrict content so it can only be viewed by authenticated users.

#[get("/private-content")]
fn private_content(user: User) -> &'static str {
    "If you can see this, you are logged in."
}

Fields

is_admin: bool

Implementations

impl User

pub fn set_password(&mut self, new: &str) -> Result<(), 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.

#[get("/reset-password/<id>/<new_password>")]
async fn reset_password(id: i32, new_password: String, users: &State<Users>) -> Result<(), Error> {
    let mut user = users.get_by_id(id).await?;
    user.set_password(&new_password);
    users.modify(&user).await?;
    Ok(())
}

pub fn id(&self) -> i32

This is an accessor function for the private id field. This field is private so it is not modified by accident when updating a 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.

#[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: &str) -> Result<(), Error>

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

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for User

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for User

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 User

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<User, Error>> + Send + 'async_trait>> where
    'r: 'async_trait,
    'life0: 'async_trait, 

Derives an instance of Self from the incoming request metadata.

impl<'a, R: Row> FromRow<'a, R> for User where
    &'a str: ColumnIndex<R>,
    i32: Decode<'a, R::Database>,
    i32: Type<R::Database>,
    String: Decode<'a, R::Database>,
    String: Type<R::Database>,
    bool: Decode<'a, R::Database>,
    bool: Type<R::Database>,
    String: Decode<'a, R::Database>,
    String: Type<R::Database>, 

fn from_row(row: &'a R) -> Result<Self>

impl Hash for User

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for User

fn cmp(&self, other: &User) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<User> for User

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<User> for User

fn partial_cmp(&self, other: &User) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for User

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'_ Row<'a>> for User

type Error = Error

The type returned in the event of a conversion error.

fn try_from(row: &Row<'_>) -> Result<User, Error>

Performs the conversion.

impl TryFrom<Row> for User

type Error = Error

The type returned in the event of a conversion error.

fn try_from(row: Row) -> Result<User>

Performs the conversion.

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 User

impl StructuralEq for User

impl StructuralPartialEq for User