summary refs log tree commit diff
path: root/src/libstd/path/mod.rs
diff options
context:
space:
mode:
authorKevin Ballard <kevin@sb.org>2013-10-02 22:29:46 -0700
committerKevin Ballard <kevin@sb.org>2013-10-15 21:56:54 -0700
commited539e14712539473c3e89604cb69e2307110772 (patch)
treebc92a3c7dfe9aa37daa589352de69f73adb4eab3 /src/libstd/path/mod.rs
parenteaec8a71322a59eb284cbd5a8d502b6da321df3c (diff)
downloadrust-ed539e14712539473c3e89604cb69e2307110772.tar.gz
rust-ed539e14712539473c3e89604cb69e2307110772.zip
path2: Remove Path::normalize()
There are no clients of this API, so just remove it.

Update the module docstring to mention normalization.
Diffstat (limited to 'src/libstd/path/mod.rs')
-rw-r--r--src/libstd/path/mod.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libstd/path/mod.rs b/src/libstd/path/mod.rs
index 41fe31daae9..1ecb31a2a87 100644
--- a/src/libstd/path/mod.rs
+++ b/src/libstd/path/mod.rs
@@ -43,6 +43,10 @@ Option<&str> with `.as_str()`. Similarly, attributes of the path can be queried
 with methods such as `.filename()`. There are also methods that return a new
 path instead of modifying the receiver, such as `.join()` or `.dir_path()`.
 
+Paths are always kept in normalized form. This means that creating the path
+`Path::from_str("a/b/../c")` will return the path `a/c`. Similarly any attempt
+to mutate the path will always leave it in normalized form.
+
 When rendering a path to some form of display, there is a method `.display()`
 which is compatible with the `format!()` parameter `{}`. This will render the
 path as a string, replacing all non-utf8 sequences with the Replacement