1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/* Copyright 2016 Joshua Gentry
 *
 * Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 * http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
 * <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
 * option. This file may not be copied, modified, or distributed
 * except according to those terms.
 */

//*************************************************************************************************
/// Enumeration to identify the state of a user's session.
#[derive(Debug, Copy, Clone)]
pub enum FeSessionState
{
    //---------------------------------------------------------------------------------------------
    /// The session exists and is active.
    Active,

    //---------------------------------------------------------------------------------------------
    /// There is no session, however the client provided a session cookie.  So the session must
    /// have expired.
    Expired,

    //---------------------------------------------------------------------------------------------
    /// There is no session and the client did not provide a session cookie.
    None
}

 impl FeSessionState
 {
     //********************************************************************************************
     /// Helper method to check if the session is active.
     pub fn is_active(&self) -> bool
     {
         match *self
         {
             FeSessionState::Active => true,
             _                      => false
         }
     }

     //********************************************************************************************
     /// Helper method to check if the session is expired.
     pub fn is_expired(&self) -> bool
     {
         match *self
         {
             FeSessionState::Expired => true,
             _                       => false
         }
     }

     //********************************************************************************************
     /// Helper method to check if the session doesn't exist.
     pub fn is_none(&self) -> bool
     {
         match *self
         {
             FeSessionState::None => true,
             _                    => false
         }
     }
 }