Make file serving helpers public

src/filters/fs.rs

@@ -135,12 +135,19 @@ fn sanitize_path(base: impl AsRef<Path>, tail: &str) -> Result<PathBuf, Rejectio
     Ok(buf)
 }
 
-#[derive(Debug)]
-struct Conditionals {
-    if_modified_since: Option<IfModifiedSince>,
-    if_unmodified_since: Option<IfUnmodifiedSince>,
-    if_range: Option<IfRange>,
-    range: Option<Range>,
+/// Conditionals that define certain aspects of file serving. These are usually based on the headers of a request, though they can be manually constructed.
+#[derive(Debug, Default)]
+pub struct Conditionals {
+    /// Only respond with the file if it has been modified since this date. [See MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since).
+    pub if_modified_since: Option<IfModifiedSince>,
+    /// Only respond with the file if it hasn't been modified since this date. [See MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Unmodified-Since).
+    pub if_unmodified_since: Option<IfUnmodifiedSince>,
+    /// The `range` conditional should only be used if the document has not been modified since the `Last Modified` header
+    /// or the last ETag creation date. This is typically used to resume downloads after a pause to make sure that the requested
+    /// resource hasn't been changed since the first partial download. [See MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Range).
+    pub if_range: Option<IfRange>,
+    /// The part of the file that should be responded with. [See MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range).
+    pub range: Option<Range>,
 }
 
 enum Cond {
@@ -198,7 +205,8 @@ impl Conditionals {
     }
 }
 
-fn conditionals() -> impl Filter<Extract = One<Conditionals>, Error = Infallible> + Copy {
+/// A filter for extracting certain headers related to static file serving.
+pub fn conditionals() -> impl Filter<Extract = One<Conditionals>, Error = Infallible> + Copy {
     crate::header::optional2()
         .and(crate::header::optional2())
         .and(crate::header::optional2())
@@ -245,9 +253,9 @@ impl File {
     }
 }
 
-// Silly wrapper since Arc<PathBuf> doesn't implement AsRef<Path> ;_;
+/// A wrapper for `Arc<PathBuf>` that implements `AsRef<Path>`.
 #[derive(Clone, Debug)]
-struct ArcPath(Arc<PathBuf>);
+pub struct ArcPath(pub Arc<PathBuf>);
 
 impl AsRef<Path> for ArcPath {
     fn as_ref(&self) -> &Path {
@@ -261,7 +269,11 @@ impl Reply for File {
     }
 }
 
-fn file_reply(
+/// An internal helper for serving static files.
+///
+/// Usually, you'll want to use this with `warp::fs::file`, but if the file's path is based on something extracted with a filter,
+/// you'll need to use this manually.
+pub fn file_reply(
     path: ArcPath,
     conditionals: Conditionals,
 ) -> impl Future<Output = Result<File, Rejection>> + Send {