diff --git a/actix-session/.idea/workspace.xml b/actix-session/.idea/workspace.xml index 780045bdb..3e899d8d9 100644 --- a/actix-session/.idea/workspace.xml +++ b/actix-session/.idea/workspace.xml @@ -7,11 +7,7 @@ - - - - - + - { - "keyToString": { - "RunOnceActivity.OpenProjectViewOnStart": "true", - "RunOnceActivity.ShowReadmeOnStart": "true", - "git-widget-placeholder": "master", - "last_opened_file_path": "/Users/jameseastham/source/github/actix-extras/actix-session", - "nodejs_package_manager_path": "npm", - "org.rust.cargo.project.model.PROJECT_DISCOVERY": "true", - "vue.rearranger.settings.migration": "true" + +}]]> + + + + + \ No newline at end of file diff --git a/actix-session/src/storage/dynamo_db.rs b/actix-session/src/storage/dynamo_db.rs index 04f850dc5..6edb9e513 100644 --- a/actix-session/src/storage/dynamo_db.rs +++ b/actix-session/src/storage/dynamo_db.rs @@ -77,6 +77,10 @@ pub struct DynamoDbSessionStore { client: Client, } + +/// Struct for configuring the DynamoDB Session Store. To add custom configuration, use the `DynamoDbSessionStoreBuilder` +/// +/// [`DynamoDbSessionStoreBuilder`]: crate::storage::DynamoDbSessionStoreBuilder #[derive(Clone)] pub struct CacheConfiguration { cache_keygen: Arc String + Send + Sync>, @@ -92,6 +96,22 @@ pub struct CacheConfiguration { } impl Default for CacheConfiguration { + /// Default values for the cache configuration + /// + /// ```no_run + /// Self { + /// cache_keygen: Arc::new(str::to_owned), + /// table_name: "sessions".to_string(), + /// use_dynamo_db_local: false, + /// key_name: "SessionId".to_string(), + /// ttl_name: "session_ttl".to_string(), + /// session_data_name: "session_data".to_string(), + /// dynamo_db_local_endpoint: "http://localhost:8000".to_string(), + /// sdk_config: None, + /// region: None, + /// credentials: None, + /// } + /// ``` fn default() -> Self { Self { cache_keygen: Arc::new(str::to_owned),