Struct lrau::user::User

pub struct User {
    pub username: String,
    pub password: String,
    pub permissions: Permissions,
    pub logged_in: Option<Instant>,
    pub expire: Option<Duration>,
}

The User struct stores information about an individual login.

It support serde and so can be serialized to, for example, json or toml. For sql support you can convert it to a SqlUser

Fields

username: String

This is then username / id of the user

password: String

This is the password of the user.

This is stores hashed with Argon2id.

permissions: Permissions

logged_in: Option<Instant>

This stores information about wether the user is logged in or not.

expire: Option<Duration>

This is how long until the user is expire.

Implementations

impl User

pub const fn new_basic(
    username: String,
    password: String,
    permissions: Permissions
) -> Self

Creates a new user from an existing hash.

pub fn new(
    username: String,
    password: &str,
    permissions: Permissions
) -> Result<Self>

Creates a new user. The field password is the unhashed password. After this is suplied the program will hash it using the Argon2id agorithm.

The username field is any username which you wish to identify the user by.

Permissions is a representation of the permissions for the user.

pub fn reset_pass(&mut self, password: &str) -> Result<()>

Resets a user’s password. The given password will replace whatever was given previously.

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

Validates a users password.

pub fn log_in(&mut self, password: &str, expire: Duration) -> Result<bool>

Logs a user in

pub fn check_login(&self) -> bool

Checks if the user is logged in.

This does not check if the user has expired.

pub fn check_valid_login(&self) -> bool

Checks for a valid login. This makes sure the user is logged in and has a valid session.

pub fn get_permission<T>(&self, path: &[T], mut: bool) -> bool where
    String: PartialEq<T>, 

Checks if a user has permissions to do something.

Note this does not check for a valid session.

pub fn get_valid_permissions<T>(
    &self,
    path: &[T],
    mut: bool
) -> Result<bool, SessionExpired> where
    String: PartialEq<T>, 

Checks if the user has permissions to do something.

This function also checks if they have a valid session and will return an Err if they do not.

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 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 Eq for User

impl StructuralEq for User

impl StructuralPartialEq for User