From 1e8783e23c3c5e64acc40464329b64e3de6e2a20 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vojt=C4=9Bch=20Pej=C5=A1a?= <vojtechpejsa7@gmail.com>
Date: Mon, 25 Mar 2019 14:44:45 +0100
Subject: Document file upload.

---
 src/file_upload.rs | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

(limited to 'src/file_upload.rs')

diff --git a/src/file_upload.rs b/src/file_upload.rs
index f72ab8b..c0ec95f 100644
--- a/src/file_upload.rs
+++ b/src/file_upload.rs
@@ -9,7 +9,8 @@ use std::{
     path::{Component, PathBuf},
 };
 
-pub fn save_file(
+/// Create future to save file.
+fn save_file(
     field: multipart::Field<dev::Payload>,
     file_path: PathBuf,
 ) -> Box<Future<Item = i64, Error = Error>> {
@@ -30,7 +31,8 @@ pub fn save_file(
     )
 }
 
-pub fn handle_multipart(
+/// Create new future to handle file as multipart data.
+fn handle_multipart(
     item: multipart::MultipartItem<dev::Payload>,
     mut file_path: PathBuf,
 ) -> Box<Stream<Item = i64, Error = Error>> {
@@ -65,6 +67,11 @@ pub fn handle_multipart(
     }
 }
 
+/// Handle incoming request to upload file.
+/// Target file path is expected as path parameter in URI and is interpreted as relative from
+/// server root directory. Any path which will go outside of this directory is considered
+/// invalid.
+/// This method returns future.
 pub fn upload_file(req: &HttpRequest<crate::MiniserveConfig>) -> FutureResponse<HttpResponse> {
     if !req.query().contains_key("path") {
         return Box::new(future::ok(
-- 
cgit v1.2.3