about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2016-07-23 01:57:21 +0200
committerGuillaume Gomez <guillaume1.gomez@gmail.com>2016-07-23 01:57:21 +0200
commit90bb8d469c495f48cf0da67c7811fd887a8b0655 (patch)
treedfe676ba7c6ea878bbabc7828ddcac0924a6b1e6 /src
parentfd1d3603d46422bef6531a2d74401361ba1d822b (diff)
downloadrust-90bb8d469c495f48cf0da67c7811fd887a8b0655.tar.gz
rust-90bb8d469c495f48cf0da67c7811fd887a8b0655.zip
Add DirBuilder doc examples
Diffstat (limited to 'src')
-rw-r--r--src/libstd/fs.rs19
-rw-r--r--src/libstd/sys/unix/ext/fs.rs10
2 files changed, 28 insertions, 1 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index c28f70b8692..c74e508a69b 100644
--- a/src/libstd/fs.rs
+++ b/src/libstd/fs.rs
@@ -1397,6 +1397,14 @@ pub fn set_permissions<P: AsRef<Path>>(path: P, perm: Permissions)
 impl DirBuilder {
     /// Creates a new set of options with default mode/security settings for all
     /// platforms and also non-recursive.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::fs::DirBuilder;
+    ///
+    /// let builder = DirBuilder::new();
+    /// ```
     #[stable(feature = "dir_builder", since = "1.6.0")]
     pub fn new() -> DirBuilder {
         DirBuilder {
@@ -1409,7 +1417,16 @@ impl DirBuilder {
     /// all parent directories if they do not exist with the same security and
     /// permissions settings.
     ///
-    /// This option defaults to `false`
+    /// This option defaults to `false`.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::fs::DirBuilder;
+    ///
+    /// let mut builder = DirBuilder::new();
+    /// builder.recursive(true);
+    /// ```
     #[stable(feature = "dir_builder", since = "1.6.0")]
     pub fn recursive(&mut self, recursive: bool) -> &mut Self {
         self.recursive = recursive;
diff --git a/src/libstd/sys/unix/ext/fs.rs b/src/libstd/sys/unix/ext/fs.rs
index bb90a977433..d1f26fec249 100644
--- a/src/libstd/sys/unix/ext/fs.rs
+++ b/src/libstd/sys/unix/ext/fs.rs
@@ -239,6 +239,16 @@ pub fn symlink<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()>
 pub trait DirBuilderExt {
     /// Sets the mode to create new directories with. This option defaults to
     /// 0o777.
+    ///
+    /// # Examples
+    ///
+    /// ```ignore
+    /// use std::fs::DirBuilder;
+    /// use std::os::unix::fs::DirBuilderExt;
+    ///
+    /// let mut builder = DirBuilder::new();
+    /// builder.mode(0o755);
+    /// ```
     #[stable(feature = "dir_builder", since = "1.6.0")]
     fn mode(&mut self, mode: u32) -> &mut Self;
 }