Add missing links and examples for FileExt #45631

GuillaumeGomez · 2017-10-30T12:49:16Z

r? @rust-lang/docs

kennytm · 2017-10-30T13:03:12Z

src/libstd/sys/unix/ext/fs.rs

+    /// file.write_at(b"sushi", 10);
+    /// # Ok(())
+    /// # }
+    /// ```    


[00:03:41] tidy error: /checkout/src/libstd/sys/unix/ext/fs.rs:90: trailing whitespace

GuillaumeGomez · 2017-10-30T13:44:30Z

Updated.

frewsxcv · 2017-10-30T13:49:00Z

src/libstd/sys/unix/ext/fs.rs

+    /// let file = File::open("foo.txt")?;
+    ///
+    /// // We now read 8 bytes from the offset 10.
+    /// file.read_at(buf, 10);


What do you think about adding ? at the end of the method call instead of ignoring the result?

I could just remove the ';'.

kennytm · 2017-10-30T18:37:28Z

src/libstd/sys/unix/ext/fs.rs

    /// short write.
+    ///
+    /// [`File::write`]: ../../../std/fs/struct.File.html#write.v


Broken link, needs one more ../.

[01:13:11] std/os/unix/fs/trait.FileExt.html:70: broken link - std/std/fs/struct.File.html [01:13:11] std/os/unix/fs/trait.FileExt.html:95: broken link - std/std/fs/struct.File.html [01:13:20] thread 'main' panicked at 'found some broken links', /checkout/src/tools/linkchecker/main.rs:49:8 [01:13:20] note: Run with `RUST_BACKTRACE=1` for a backtrace.

ollie27 · 2017-11-01T22:55:38Z

src/libstd/sys/unix/ext/fs.rs

+    /// let buf = &mut [0u8; 8];
+    /// let file = File::open("foo.txt")?;
+    ///
+    /// // We now read 8 bytes from the offset 10.


This will only read up to 8 bytes so I think it's important to do something with the value read_at returns in this example. The same goes for write_at.

Good point.

maybe something like this?

// Read up to 8 bytes from the offset 10. let num_bytes_read = file.read_at(buf, 10)?; println!("read {} bytes: {:?}", num_bytes_read, buf);

carols10cents · 2017-11-06T14:07:44Z

r? @frewsxcv

QuietMisdreavus · 2017-11-07T01:48:07Z

src/libstd/sys/unix/ext/fs.rs

+    ///
+    /// # use std::io;
+    /// # fn f() -> io::Result<()> {
+    /// let buf = &mut [0u8; 8];


Can you make this let mut buf = [0u8; 8]; and pass &mut buf to read_at? That way it'll match what we have in std::io::Read.

QuietMisdreavus · 2017-11-07T01:51:01Z

src/libstd/sys/unix/ext/fs.rs

    /// short read.
+    ///
+    /// [`File::read`]: ../../../../std/fs/struct.File.html#read.v


Why did you use read.v instead of method.read? I know they go to the same spot but i'm more used to reading the method. style link anchors. (Same for write farther down.)

It's not targetting the same thing actually. :)

I would consider "the first child element of a container versus the container itself" to be close enough.

Hum, good point.

frewsxcv

r=me with @QuietMisdreavus's and @ollie27's comments addressed

frewsxcv · 2017-11-07T02:36:39Z

src/libstd/sys/unix/ext/fs.rs

+    /// let buf = &mut [0u8; 8];
+    /// let file = File::open("foo.txt")?;
+    ///
+    /// // We now read 8 bytes from the offset 10.


maybe something like this?

// Read up to 8 bytes from the offset 10. let num_bytes_read = file.read_at(buf, 10)?; println!("read {} bytes: {:?}", num_bytes_read, buf);

frewsxcv · 2017-11-08T03:16:14Z

src/libstd/sys/unix/ext/fs.rs

+    /// let mut buf = [0u8; 8];
+    /// let file = File::open("foo.txt")?;
+    ///
+    /// // We now read 8 bytes from the offset 10.


this is not guaranteed to read 8 bytes, so phrasing it as 'up to 8 bytes' is a bit more accurate

bors · 2017-11-08T12:26:10Z

☔ The latest upstream changes (presumably #45862) made this pull request unmergeable. Please resolve the merge conflicts.

frewsxcv · 2017-11-09T15:48:07Z

r=me with merge conflicts addressed

GuillaumeGomez · 2017-11-11T12:37:29Z

@bors: r=frewsxcv rollup

bors · 2017-11-11T12:37:30Z

📌 Commit c09adc4 has been approved by frewsxcv

…wsxcv Add missing links and examples for FileExt r? @rust-lang/docs

Rollup of 4 pull requests - Successful merges: #45631, #45812, #45877, #45919 - Failed merges:

kennytm added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 30, 2017

kennytm reviewed Oct 30, 2017

View reviewed changes

GuillaumeGomez force-pushed the file-ext-docs branch from 09c501f to 376f8dc Compare October 30, 2017 13:44

frewsxcv reviewed Oct 30, 2017

View reviewed changes

GuillaumeGomez force-pushed the file-ext-docs branch from 376f8dc to 8382304 Compare October 30, 2017 16:27

kennytm reviewed Oct 30, 2017

View reviewed changes

GuillaumeGomez force-pushed the file-ext-docs branch from 8382304 to 8892230 Compare October 31, 2017 00:00

ollie27 reviewed Nov 1, 2017

View reviewed changes

rust-highfive assigned frewsxcv Nov 6, 2017

QuietMisdreavus reviewed Nov 7, 2017

View reviewed changes

frewsxcv approved these changes Nov 7, 2017

View reviewed changes

GuillaumeGomez force-pushed the file-ext-docs branch from 8892230 to 062705d Compare November 7, 2017 19:51

frewsxcv reviewed Nov 8, 2017

View reviewed changes

GuillaumeGomez force-pushed the file-ext-docs branch from 062705d to 7035a25 Compare November 8, 2017 09:01

kennytm added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 9, 2017

Add missing links and examples for FileExt

c09adc4

GuillaumeGomez force-pushed the file-ext-docs branch from 7035a25 to c09adc4 Compare November 11, 2017 12:37

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Nov 11, 2017

Rollup merge of rust-lang#45631 - GuillaumeGomez:file-ext-docs, r=fre…

cb71247

…wsxcv Add missing links and examples for FileExt r? @rust-lang/docs

GuillaumeGomez mentioned this pull request Nov 11, 2017

Rollup of 4 pull requests #45932

Merged

bors added a commit that referenced this pull request Nov 11, 2017

Auto merge of #45932 - GuillaumeGomez:rollup, r=GuillaumeGomez

965ace5

Rollup of 4 pull requests - Successful merges: #45631, #45812, #45877, #45919 - Failed merges:

bors merged commit c09adc4 into rust-lang:master Nov 11, 2017

GuillaumeGomez deleted the file-ext-docs branch November 11, 2017 17:03

Add missing links and examples for FileExt #45631

Add missing links and examples for FileExt #45631

Uh oh!

Conversation

GuillaumeGomez commented Oct 30, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Oct 30, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carols10cents commented Nov 6, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frewsxcv left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bors commented Nov 8, 2017

Uh oh!

frewsxcv commented Nov 9, 2017

Uh oh!

GuillaumeGomez commented Nov 11, 2017

Uh oh!

bors commented Nov 11, 2017

Uh oh!

Uh oh!