cataclysm 0.5.5

A simple http framework
Documentation 
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

pub use self::session_creator::SessionCreator;
pub use self::session_parser::{SessionParser};
pub use self::json_session_parser::{JsonSessionParser};
#[cfg(feature = "cookie")]
pub use self::cookie_session::{CookieSessionBuilder, SignedCookieSession, EncryptedCookieSession, SameSite};

mod session_creator;
mod session_parser;
mod json_session_parser;
#[cfg(feature = "cookie")]
mod cookie_session;

use crate::{Extractor, Error, http::{Request, Response}, additional::Additional};
use std::sync::Arc;
use serde::{Serialize, de::{DeserializeOwned}};

/// Session structure, with strongly typed functionality
///
/// Sessions, by default, store values in a one-level string to string json, which is represented by a [HashMap](https://doc.rust-lang.org/std/collections/struct.HashMap.html).
/// In order to deserialize any oder kind of structure, you can specify the first generic argument of the [Session] struct.
pub struct Session<B = std::collections::HashMap<String, String>, P = JsonSessionParser> {
    inner: Option<B>,
    phantom: std::marker::PhantomData<P>,
    session_creator: Arc<Box<dyn SessionCreator>>
}

impl<B, P> Session<B, P> {
    /// Creates a new session
    fn new(session_creator: Arc<Box<dyn SessionCreator>>) -> Session<B, P> {
        Session{
            inner: None,
            phantom: std::marker::PhantomData,
            session_creator
        }
    }
}

impl<B, P> std::ops::Deref for Session<B, P> {
    type Target = Option<B>;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl<B, P> std::ops::DerefMut for Session<B, P> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.inner
    }
}

impl<B: Send + Serialize, P: SessionParser<B>> Session<B, P> {
    /// Applies all the changes of the session to the response.
    ///
    /// It is not the most elegant solution, but soon a new one will be worked out to apply the session changes to the response (probably using layers).
    pub fn apply(self, req: Response) -> Result<Response, Error> {
        let content = serde_json::to_string(&self.inner)?;
        self.session_creator.apply(content, req)
    }
}

impl<T: Sync, B: 'static + Send + DeserializeOwned, P: 'static + Send + SessionParser<B>> Extractor<T> for Session<B, P> {
    fn extract(req: &Request, additional: Arc<Additional<T>>) -> Result<Self, Error> {
        if let Some(session_creator) = &additional.session_creator {
            match session_creator.parse(req)? {
                Some(content) => {
                    let inner = serde_json::from_str(&content).map_err(|e| Error::ExtractionBR(format!("{}", e)))?;
                    Ok(Session {
                        inner,
                        phantom: std::marker::PhantomData,
                        session_creator: session_creator.clone()
                    })
                },
                None => Ok(Session::new(session_creator.clone()))
            }
        } else {
            // Forcefully log an error message, as this should be quickly noticed by the developer
            log::error!("cataclysm error: you need to setup a `SessionCreator` before you try to use the `Session` extractor!");
            Err(Error::NoSessionCreator)
        }
    }
}