Update conditionals docs, mark subdirs as pub

Author: yoshuawuyts

src/conditional/if_match.rs

@@ -1,3 +1,5 @@
+//! Apply the HTTP method if the ETag matches.
+
 use crate::conditional::MatchDirective;
 use crate::headers::{HeaderName, HeaderValue, Headers, ToHeaderValues, IF_MATCH};
 
@@ -6,7 +8,7 @@ use std::iter::Iterator;
 use std::option;
 use std::slice;
 
-/// HTTP `If-Match` header.
+/// Apply the HTTP method if the ETag matches.
 ///
 /// # Specifications
 ///

src/conditional/if_modified_since.rs

@@ -5,7 +5,8 @@ use std::fmt::Debug;
 use std::option;
 use std::time::SystemTime;
 
-/// HTTP `IfModifiedSince` header
+/// Apply the HTTP method if the entity has been modified after the given
+/// date.
 ///
 /// # Specifications
 ///

src/conditional/if_none_match.rs

@@ -1,3 +1,8 @@
+//! Apply the HTTP method if the ETags do not match.
+//!
+//! This is used to update caches or to prevent uploading a new resource when
+//! one already exists.
+
 use crate::conditional::MatchDirective;
 use crate::headers::{HeaderName, HeaderValue, Headers, ToHeaderValues, IF_NONE_MATCH};
 
@@ -6,7 +11,10 @@ use std::iter::Iterator;
 use std::option;
 use std::slice;
 
-/// HTTP `If-None-Match` header.
+/// Apply the HTTP method if the ETags do not match.
+///
+/// This is used to update caches or to prevent uploading a new resource when
+/// one already exists.
 ///
 /// # Specifications
 ///

src/conditional/if_unmodified_since.rs

@@ -5,7 +5,8 @@ use std::fmt::Debug;
 use std::option;
 use std::time::SystemTime;
 
-/// HTTP `IfUnmodifiedSince` header
+/// Apply the HTTP method if the entity has not been modified after the
+/// given date.
 ///
 /// # Specifications
 ///

src/conditional/last_modified.rs

@@ -5,7 +5,7 @@ use std::fmt::Debug;
 use std::option;
 use std::time::SystemTime;
 
-/// HTTP `LastModified` header
+/// The last modification date of a resource.
 ///
 /// # Specifications
 ///

src/conditional/match_directive.rs

@@ -1,7 +1,7 @@
 use crate::conditional::ETag;
 use crate::headers::HeaderValue;
 
-/// An Entity Tag based match directive.
+/// An ETag-based match directive.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum MatchDirective {
     /// An ETag.

src/conditional/mod.rs

@@ -9,17 +9,24 @@
 //! - [MDN: HTTP Conditional Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests)
 
 mod etag;
-mod if_match;
 mod if_modified_since;
-mod if_none_match;
 mod if_unmodified_since;
 mod last_modified;
 mod match_directive;
 
+pub mod if_match;
+pub mod if_none_match;
+
 pub use etag::ETag;
+pub use match_directive::MatchDirective;
+
+#[doc(inline)]
 pub use if_match::IfMatch;
+#[doc(inline)]
 pub use if_modified_since::IfModifiedSince;
+#[doc(inline)]
 pub use if_none_match::IfNoneMatch;
+#[doc(inline)]
 pub use if_unmodified_since::IfUnmodifiedSince;
+#[doc(inline)]
 pub use last_modified::LastModified;
-pub use match_directive::MatchDirective;