Struct sudoku_backend::ops::Session

pub struct Session {
    pub id: Option<i32>,
    pub expiry: NaiveDateTime,
    pub is_admin: bool,
    pub user_id: Option<i32>,
    pub sudoku_board_id: Option<i32>,
    pub board_skeleton: Option<Cow<'static, str>>,
    pub solve_start: Option<NaiveDateTime>,
}

Refer to doc/session.md for more details.

Fields

id: Option<i32>

Unique user ID.

Actually not optional, but this allows us to get an ID from the database.

expiry: NaiveDateTime

Time the cookie expires, defaults to a day from creation time.

is_admin: bool

Whether the user is logged in as admin (always false if user_id == None).

user_id: Option<i32>

The logged-in user ID, or None for unauthed access.

sudoku_board_id: Option<i32>

ID of board currently being solved

board_skeleton: Option<Cow<'static, str>>

The board skeleton sent to the user

solve_start: Option<NaiveDateTime>

Time the solving started

Methods

impl Session

pub fn new() -> Session

Create an empty session expiring a day from the creation datetime.

Put it in the database to get an ID to put back in the cookie.

pub fn get(     db: &SqliteConnection,     cookies: &mut Cookies ) -> Result<Session, &'static str>

Get/create a session for the specified cookieset.

pub fn start_game<S: Into<Cow<'static, str>>>(     &mut self,     bid: i32,     skeleton: S,     db: &SqliteConnection ) -> Result<(), &'static str>

Update the in-memory and in-DB model to start playing the specified game.

Examples

let mut sess = Session {
    id: Some(32),
    expiry: NaiveDate::from_ymd(2018, 7, 9).and_hms(12, 40, 26),
    is_admin: false,
    user_id: None,
    sudoku_board_id: None,
    board_skeleton: None,
    solve_start: None,
};

let skeleton = "3....5....25.81.........6......4..73.3....14..1.7......8...9.12.97........2..8.54";
sess.start_game(24, skeleton, &db).unwrap();

assert_eq!(sess, Session {
    id: Some(32),
    expiry: NaiveDate::from_ymd(2018, 7, 9).and_hms(12, 40, 26),
    is_admin: false,
    user_id: None,
    sudoku_board_id: Some(24),
    board_skeleton: Some(skeleton.into()),
    solve_start: Some(NaiveDateTime::from_timestamp(Utc::now().timestamp(), 0)),
});

pub fn stop_game(&mut self, db: &SqliteConnection) -> Result<(), &'static str>

Update the in-memory and in-DB model to start playing the specified game.

Examples

let mut sess = Session {
    id: Some(32),
    expiry: NaiveDate::from_ymd(2018, 7, 9).and_hms(12, 40, 26),
    is_admin: false,
    user_id: None,
    sudoku_board_id: Some(24),
    board_skeleton: Some("3....5....25.81.........6......4..73.3....14..1.7......8...9.12.97........2..8.54".into()),
    solve_start: Some(NaiveDate::from_ymd(2018, 7, 9).and_hms(2, 41, 27)),
};

sess.stop_game(&db).unwrap();

assert_eq!(sess, Session {
    id: Some(32),
    expiry: NaiveDate::from_ymd(2018, 7, 9).and_hms(12, 40, 26),
    is_admin: false,
    user_id: None,
    sudoku_board_id: None,
    board_skeleton: None,
    solve_start: None,
});

pub fn game_started(&self) -> bool

Check if this session has a game going

pub fn log_in(     &mut self,     uid: i32,     is_admin: bool,     db: &SqliteConnection ) -> Result<(), &'static str>

Update the in-memory and in-DB model to be logged in as the specified user with the specified permissions.

Examples

Before:

INSERT INTO "sessions" VALUES(32, '2018-07-09 12:40:26', 0, NULL, NULL, NULL, NULL);

Update:

let mut sess = Session {
    id: Some(32),
    expiry: NaiveDate::from_ymd(2018, 7, 9).and_hms(12, 40, 26),
    is_admin: false,
    user_id: None,
    sudoku_board_id: None,
    board_skeleton: None,
    solve_start: None,
};

sess.log_in(18, true, &db).unwrap();

assert_eq!(sess, Session {
    id: Some(32),
    expiry: NaiveDate::from_ymd(2018, 7, 9).and_hms(12, 40, 26),
    is_admin: true,
    user_id: Some(18),
    sudoku_board_id: None,
    board_skeleton: None,
    solve_start: None,
});

After:

INSERT INTO "sessions" VALUES(32, '2018-07-09 12:40:26', 1, 18, NULL, NULL, NULL);

pub fn log_out(&mut self, db: &SqliteConnection) -> Result<(), &'static str>

Update the in-memory and in-DB model to not be logged in nor be admin.

Examples

Before:

INSERT INTO "sessions" VALUES(32, '2018-07-09 12:40:26', 1, 18, NULL, NULL, NULL);

Update:

let mut sess = Session {
    id: Some(32),
    expiry: NaiveDate::from_ymd(2018, 7, 9).and_hms(12, 40, 26),
    is_admin: true,
    user_id: Some(18),
    sudoku_board_id: None,
    board_skeleton: None,
    solve_start: None,
};

sess.log_out(&db).unwrap();

assert_eq!(sess, Session {
    id: Some(32),
    expiry: NaiveDate::from_ymd(2018, 7, 9).and_hms(12, 40, 26),
    is_admin: false,
    user_id: None,
    sudoku_board_id: None,
    board_skeleton: None,
    solve_start: None,
});

After:

INSERT INTO "sessions" VALUES(32, '2018-07-09 12:40:26', 0, NULL, NULL, NULL, NULL);

Trait Implementations

impl PartialEq<Session> for Session

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

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

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

This method tests for !=.

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Session

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

impl PartialOrd<Session> for Session

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

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

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

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

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

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

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

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

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

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

impl Debug for Session

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

Formats the value using the given formatter.

impl Hash for Session

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 Serialize for Session

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Session

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'insert> Insertable<table> for Session

type Values = <(Option<Eq<id, i32>>, Option<Eq<expiry, NaiveDateTime>>, Option<Eq<is_admin, bool>>, Option<Eq<user_id, i32>>, Option<Eq<sudoku_board_id, i32>>, Option<Eq<board_skeleton, Cow<'static, str>>>, Option<Eq<solve_start, NaiveDateTime>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values(self) -> Self::Values

Construct Self::Values

fn insert_into(     self,     table: T ) -> InsertStatement<T, Self::Values, Insert, NoReturningClause>

Insert self into a given table.

impl<'insert> Insertable<table> for &'insert Session

type Values = <(Option<Eq<id, &'insert i32>>, Option<Eq<expiry, &'insert NaiveDateTime>>, Option<Eq<is_admin, &'insert bool>>, Option<Eq<user_id, &'insert i32>>, Option<Eq<sudoku_board_id, &'insert i32>>, Option<Eq<board_skeleton, &'insert Cow<'static, str>>>, Option<Eq<solve_start, &'insert NaiveDateTime>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values(self) -> Self::Values

Construct Self::Values

fn insert_into(     self,     table: T ) -> InsertStatement<T, Self::Values, Insert, NoReturningClause>

Insert self into a given table.

impl<__DB: Backend, __ST> Queryable<__ST, __DB> for Session where     (Option<i32>, NaiveDateTime, bool, Option<i32>, Option<i32>, Option<Cow<'static, str>>, Option<NaiveDateTime>): Queryable<__ST, __DB>,

type Row = <(Option<i32>, NaiveDateTime, bool, Option<i32>, Option<i32>, Option<Cow<'static, str>>, Option<NaiveDateTime>) as Queryable<__ST, __DB>>::Row

The Rust type you'd like to map from.

fn build(row: Self::Row) -> Self

Construct an instance of this type

impl<'update> AsChangeset for &'update Session

type Target = table

The table which Self::Changeset will be updating

type Changeset = <(Eq<expiry, &'update NaiveDateTime>, Eq<is_admin, &'update bool>, Eq<user_id, &'update Option<i32>>, Eq<sudoku_board_id, &'update Option<i32>>, Eq<board_skeleton, &'update Option<Cow<'static, str>>>, Eq<solve_start, &'update Option<NaiveDateTime>>) as AsChangeset>::Changeset

The update statement this type represents

fn as_changeset(self) -> Self::Changeset

Convert self into the actual update statement being executed

impl<'update> AsChangeset for Session

type Target = table

The table which Self::Changeset will be updating

type Changeset = <(Eq<expiry, NaiveDateTime>, Eq<is_admin, bool>, Eq<user_id, Option<i32>>, Eq<sudoku_board_id, Option<i32>>, Eq<board_skeleton, Option<Cow<'static, str>>>, Eq<solve_start, Option<NaiveDateTime>>) as AsChangeset>::Changeset

The update statement this type represents

fn as_changeset(self) -> Self::Changeset

Convert self into the actual update statement being executed

impl<'insert> UndecoratedInsertRecord<table> for Session