Commit graph

244 commits

Author SHA1 Message Date
Fabian Drinck
f580b983b1 Edit code example for File::open 2018-07-08 16:07:09 +02:00
steveklabnik
48bd07e3a9 Remove feature flag from fs::read_to_string example
This is stable, and so no longer needed
2018-06-01 08:24:36 -04:00
Aaron DeVore
bf6804b79c fs::write: Add example writing a &str 2018-05-12 08:39:05 -06:00
Tim Allen
8720314c02 fs::canonicalize has some important portability concerns. 2018-05-10 18:06:47 +10:00
Tim Allen
9d7eda96ee Mention that fs::canonicalize makes paths absolute. 2018-05-10 18:05:29 +10:00
Matt Brubeck
85310860c2 Add performance note to fs::read docs 2018-04-02 09:33:27 -07:00
bors
9ceaa5676b Auto merge of #49522 - mbrubeck:fs_read, r=SimonSapin
Rename fs::read_string to read_to_string and stabilize

As approved in https://github.com/rust-lang/rust/issues/46588#issuecomment-377530365

Closes #46588.
2018-04-01 02:44:45 +00:00
Matt Brubeck
6b7627f8c9 Rename fs::read_string to read_to_string and stabilize 2018-03-30 10:20:58 -07:00
Matt Brubeck
504916c18b fs_read_write_bytes stabilized in 1.26.0 2018-03-30 10:07:40 -07:00
bors
696076144d Auto merge of #49422 - mbrubeck:fs_read, r=TimNN
Stabilize fs::read and fs::write

As discussed in https://github.com/rust-lang/rust/issues/46588#issuecomment-373956283
2018-03-30 06:49:33 +00:00
bors
e5277c1457 Auto merge of #49357 - frewsxcv:frewsxcv-termination-doc-examples, r=GuillaumeGomez
Remove hidden `foo` functions from doc examples; use `Termination` trait.

Fixes https://github.com/rust-lang/rust/issues/49233.

Easier to review with the white-space ignoring `?w=1` feature: https://github.com/rust-lang/rust/pull/49357/files?w=1
2018-03-28 18:11:44 +00:00
Matt Brubeck
0600d0f38d Stabilize fs::read and fs::write 2018-03-28 07:43:11 -07:00
Corey Farwell
e9dcec070d Remove hidden foo functions from doc examples; use Termination trait.
Fixes https://github.com/rust-lang/rust/issues/49233.
2018-03-28 13:15:05 +02:00
Maxwell Powlison
aaac69f78e Fix Issue #48345, is_file, is_dir, and is_symlink note mutual exclusion
The methods on the structures `fs::FileType` and `fs::Metadata` of (respectively) `is_file`, `is_dir`, and
`is_symlink` had some ambiguity in documentation, where it was not noted whether files will pass those tests
exclusively or not. It is now written that the tests are mutually exclusive.

Fixes #48345.
2018-03-16 03:41:53 -04:00
jethrogb
cfad25ee8f
Clarify interfaction between File::set_len and file cursor 2018-02-23 11:57:38 -08:00
Alexis Hunt
ec905975b8 Wording fixes from review for File. 2018-02-17 08:47:03 -05:00
Alexis Hunt
e9c75a889f Add a warning to File about mutability.
Fixes #47708.
2018-02-16 08:52:20 -05:00
kennytm
66d6c855bd
Rollup merge of #47999 - jaystrictor:master, r=Mark-Simulacrum
Remove 'the this' in doc comments.
2018-02-05 01:20:56 +08:00
Jay Strict
f168700ba6 Remove 'the this' in doc comments. 2018-02-04 16:24:18 +01:00
Corey Farwell
d597da3267 Clarify shared file handler behavior of File::try_clone.
Fixes https://github.com/rust-lang/rust/issues/46578.
2018-02-03 11:50:48 -05:00
Guillaume Gomez
260653772a Rollup merge of #47520 - mbrubeck:fstat, r=Mark-Simulacrum
Use File::metadata instead of fs::metadata to choose buffer size

This replaces a `stat` syscall with `fstat` or similar, which can be faster.  Fixes #47519.
2018-01-17 23:43:31 +01:00
Matt Brubeck
e9fdee8818 Use File::metadata instead of fs::metadata to choose buffer size
This replaces a `stat` syscall with `fstat` or similar, which can be
faster.  Fixes #47519.
2018-01-17 08:37:03 -08:00
bors
48ab4cde54 Auto merge of #47268 - EdSchouten:cloudabi-libstd, r=alexcrichton
Implement libstd for CloudABI.

Though CloudABI is strongly inspired by POSIX, its absence of features that don't work well with capability-based sandboxing makes it different enough that adding bits to `sys/unix` will make things a mess. This change therefore adds CloudABI specific platform code under `sys/cloudabi`.

One of the goals of this implementation is to build as much as possible directly on top of CloudABI's system call layer, as opposed to using the C library. This is preferred, as the system call layer is supposed to be stable, whereas the C library ABI technically is not. An advantage of this approach is that it allows us to implement certain interfaces, such as mutexes and condition variables more optimally. They can be lighter than the ones provided by pthreads.

This change disables some modules that cannot realistically be implemented right now. For example, libstd's pathname abstraction is not designed with POSIX `*at()` (e.g., `openat()`) in mind. The `*at()` functions are the only set of file system APIs available on CloudABI. There is no global file system namespace, nor a process working directory. Discussions on how to port these modules over are outside the scope of this change.
2018-01-14 08:49:10 +00:00
Ed Schouten
d9d97c9f09 Make tests build on CloudABI.
There are some tests that need to be disabled on CloudABI specifically,
due to the fact that the shims cannot be built in combination with
unix::ext or windows::ext. Also improve the scoping of some imports to
suppress compiler warnings.
2018-01-11 11:28:34 +01:00
Matt Brubeck
44912bf77b Pre-allocate in fs::read and fs::read_string 2018-01-10 10:48:11 -08:00
Simon Sapin
c5eff5442c fs::{read, read_string, write}: add tracking issue number 2017-12-08 19:28:13 +01:00
Simon Sapin
1cf11b3d0b Rename fs::read_utf8 to read_string 2017-12-06 14:10:51 +01:00
Simon Sapin
7e2f756583 Generalize fs::write from &[u8] to AsRef<[u8]> 2017-11-29 13:49:35 +01:00
Simon Sapin
a379e697ab Add std::fs::read_utf8, based on File::open and read_to_string 2017-11-07 18:42:15 +01:00
Simon Sapin
c670424cbe Move File::{read,write}_contents to fs::{read,write} free functions. 2017-11-07 18:42:06 +01:00
Simon Sapin
fd518ac4b0 Add File::read_contents and File::write_contents convenience functions.
Before:

```rust
use std::fs::File;
use std::io::Read;

let mut bytes = Vec::new();
File::open(filename)?.read_to_end(&mut bytes)?;
do_something_with(bytes)
```

After:

```rust
use std::fs::File;

do_something_with(File::read_contents(filename)?)
```
2017-11-07 17:52:07 +01:00
Stephane Raux
61c0c9e5f2 Made fs::copy return the length of the main stream
On Windows with the NTFS filesystem, `fs::copy` would return the sum of the
lengths of all streams, which can be different from the length reported by
`metadata` and thus confusing for users unaware of this NTFS peculiarity.

This makes `fs::copy` return the same length `metadata` reports which is the
value it used to return before PR #26751. Note that alternate streams are still
copied; their length is just not included in the returned value.

This change relies on the assumption that the stream with index 1 is always the
main stream in the `CopyFileEx` callback. I could not find any official
document confirming this but empirical testing has shown this to be true,
regardless of whether the alternate stream is created before or after the main
stream.

Resolves #44532
2017-09-27 19:43:05 -07:00
Corey Farwell
8915683c54 Rollup merge of #44759 - durka:patch-43, r=steveklabnik
improve english in create_dir_all docs

Just minor nitpicking.
2017-09-23 00:29:19 -04:00
Alex Burka
cf2bad8d4b improve english in create_dir_all docs 2017-09-21 16:31:39 -04:00
Trevor Merrifield
04c01e0b1f Add test case for unix permissions 2017-09-17 20:13:29 -04:00
Guillaume Gomez
c4044ee39a Add note for append method in OpenOptions docs 2017-09-13 14:47:50 +02:00
Guillaume Gomez
ccd4689ca3 Add missing urls for OpenOptions docs 2017-09-13 14:46:15 +02:00
Corey Farwell
10a479ebe1 Clarify 'writable'-changing behavior of set_readonly.
Fixes https://github.com/rust-lang/rust/issues/41984.
2017-08-15 21:43:11 -04:00
Corey Farwell
5a93be48c3 Clarify readonly method is also about being 'unwritable'. 2017-08-15 10:11:37 -04:00
Bastien Orivel
3ab86fbab2 Fix some typos 2017-08-12 14:01:11 +02:00
Guillaume Gomez
9e25984ee1 Add missing links in ReadDir docs 2017-08-10 23:01:59 +02:00
Guillaume Gomez
645117fd96 Add missing links on File struct docs 2017-08-10 22:50:29 +02:00
NODA, Kai
2e8859ce4e
libstd: remove redundant & from &Path::new(...)
fn Path::new<S: AsRef ...>(s: &S) -> &Path

Signed-off-by: NODA, Kai <nodakai@gmail.com>
2017-07-18 00:07:09 +08:00
Tobias Bucher
2783d0f7da Add links to the ErrorKind variants in errors of open 2017-06-28 13:43:56 +02:00
Tobias Bucher
71252d9b80 Document possible io::ErrorKinds of fs::open
Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC #40322
2017-06-27 12:09:56 +02:00
Steven Fackler
ecbb896b9e Add Read::initializer.
This is an API that allows types to indicate that they can be passed
buffers of uninitialized memory which can improve performance.
2017-06-20 20:26:22 -07:00
king6cong
e66388d21f doc rewording 2017-05-26 19:22:25 +08:00
Oliver Schneider
dd87eabd83 Remove need for &format!(...) or &&"" dances in span_label calls 2017-05-08 12:56:15 +02:00
Oliver Middleton
b4be475836 Fix Markdown issues in the docs
* Since the switch to pulldown-cmark reference links need a blank line
before the URLs.
* Reference link references are not case sensitive.
* Doc comments need to be indented uniformly otherwise rustdoc gets
confused.
2017-04-06 12:57:40 +01:00
Peter Gerber
ff4febf8ea Improve documentation for std::fs::DirBuilder 2017-04-02 04:06:29 +02:00