Struct sudoku_backend::ops::LoginForm

pub struct LoginForm {
    pub login: Result<NonEmpty, ()>,
    pub password: Result<HexString<SCrypt64Length>, Option<Option<usize>>>,
    pub email: Option<Result<EMail, Option<&'static str>>>,
    pub ext_error: Result<(), (Cow<'static, str>, bool)>,
}

Log-in and user-create form – refer to doc/user.md.

Examples

#[post("/login", data="<form>")]
fn login(db: DatabaseConnection, form: Form<LoginForm>)
    -> Result<String, Result<Json<GenericError>, Json<LoginError>>>
{
    let (user_id, is_admin) = form.into_inner().validate(&db).map_err(|e| Err(Json(e)))?;
    work(&db, user_id, is_admin).map_err(|e| Ok(Json(e)))
}

fn main() {
    let database_file: (String, PathBuf) = /* obtained elsewhere */;
    rocket::ignite()
        .manage(DatabaseConnection::initialise(&database_file))
        .mount("/", routes![login])
        .launch();
}

Fields

login: Result<NonEmpty, ()>

Username, non-empty.

password: Result<HexString<SCrypt64Length>, Option<Option<usize>>>

Scrypted user password, constant width.

email: Option<Result<EMail, Option<&'static str>>>

User's e-mail. Need exist for user creation.

ext_error: Result<(), (Cow<'static, str>, bool)>

Error parsing the box, see doc/user.md.

Methods

impl LoginForm

pub fn errors(&self) -> Vec<GenericError>

Get a list of errors.

Only applicable if password couldn't be parsed.

pub fn validate(&self, db: &SqliteConnection) -> Result<(i32, bool), LoginError>

Attempt to log the user in with the stored login and password.

Returns user's (id, is_admin) on success.

pub fn into_user(self) -> Result<User, LoginForm>

Attempt the conversion to a User.

Returns self, optionally with an additional error, on error.

Trait Implementations

impl PartialEq<LoginForm> for LoginForm

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

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

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

This method tests for !=.

impl Clone for LoginForm

fn clone(&self) -> LoginForm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<User> for LoginForm

fn from(user: User) -> LoginForm

Performs the conversion.

impl Ord for LoginForm

fn cmp(&self, other: &LoginForm) -> 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.

impl Eq for LoginForm

impl PartialOrd<LoginForm> for LoginForm

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

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

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

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

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

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

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

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

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

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

impl Debug for LoginForm

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

Formats the value using the given formatter.

impl<'f> FromForm<'f> for LoginForm

type Error = ()

The associated error to be returned when parsing fails.

fn from_form(it: &mut FormItems<'f>, strict: bool) -> Result<Self, Self::Error>

Parses an instance of Self from the iterator of form items it.