actix/actix-web
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-web synced 2024-11-28 01:52:57 +01:00
Code Issues Releases Wiki Activity

Improve documentation for PayloadConfig (#1923)

Browse Source
This commit is contained in:
Jonas Platte 2021-01-24 01:32:10 +01:00 committed by GitHub
parent 0c8196f8b0
commit c201c15f8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/types/payload.rs
View File

@ -191,6 +191,9 @@ fn bytes_to_string(body: Bytes, encoding: &'static Encoding) -> Result<String, E
/// building extractors on top of `Payload`. /// building extractors on top of `Payload`.
/// ///
/// By default, the payload size limit is 256kB and there is no mime type condition. /// By default, the payload size limit is 256kB and there is no mime type condition.
///
/// To use this, add an instance of it to your app or service through one of the
/// `.app_data()` methods.
#[derive(Clone)] #[derive(Clone)]
pub struct PayloadConfig { pub struct PayloadConfig {
limit: usize, limit: usize,
@ -198,7 +201,7 @@ pub struct PayloadConfig {
} }
impl PayloadConfig { impl PayloadConfig {
/// Create new instance with a size limit and no mime type condition. /// Create new instance with a size limit (in bytes) and no mime type condition.
pub fn new(limit: usize) -> Self { pub fn new(limit: usize) -> Self {
Self { Self {
limit, limit,
@ -206,7 +209,7 @@ impl PayloadConfig {
} }
} }
/// Set maximum accepted payload size. The default limit is 256kB. /// Set maximum accepted payload size in bytes. The default limit is 256kB.
pub fn limit(mut self, limit: usize) -> Self { pub fn limit(mut self, limit: usize) -> Self {
self.limit = limit; self.limit = limit;
self self