Skip to content

Commit f1537da

Browse files
Rollup merge of rust-lang#43366 - leshow:bufreader-docs, r=aturon
Fix docs: BufReader/File doesn't need to be mut Neither `BufReader` nor `File` need to be declared `mut` for most of these examples. The cookbook example using `BufReader` doesn't declare them as `mut` either (https://brson.github.io/rust-cookbook/basics.html#ex-std-read-lines).
2 parents 7e72b41 + 72e8009 commit f1537da

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/libstd/io/buffered.rs

+10-10
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ use memchr;
3737
/// use std::fs::File;
3838
///
3939
/// # fn foo() -> std::io::Result<()> {
40-
/// let mut f = File::open("log.txt")?;
40+
/// let f = File::open("log.txt")?;
4141
/// let mut reader = BufReader::new(f);
4242
///
4343
/// let mut line = String::new();
@@ -64,8 +64,8 @@ impl<R: Read> BufReader<R> {
6464
/// use std::fs::File;
6565
///
6666
/// # fn foo() -> std::io::Result<()> {
67-
/// let mut f = File::open("log.txt")?;
68-
/// let mut reader = BufReader::new(f);
67+
/// let f = File::open("log.txt")?;
68+
/// let reader = BufReader::new(f);
6969
/// # Ok(())
7070
/// # }
7171
/// ```
@@ -85,8 +85,8 @@ impl<R: Read> BufReader<R> {
8585
/// use std::fs::File;
8686
///
8787
/// # fn foo() -> std::io::Result<()> {
88-
/// let mut f = File::open("log.txt")?;
89-
/// let mut reader = BufReader::with_capacity(10, f);
88+
/// let f = File::open("log.txt")?;
89+
/// let reader = BufReader::with_capacity(10, f);
9090
/// # Ok(())
9191
/// # }
9292
/// ```
@@ -116,8 +116,8 @@ impl<R: Read> BufReader<R> {
116116
/// use std::fs::File;
117117
///
118118
/// # fn foo() -> std::io::Result<()> {
119-
/// let mut f1 = File::open("log.txt")?;
120-
/// let mut reader = BufReader::new(f1);
119+
/// let f1 = File::open("log.txt")?;
120+
/// let reader = BufReader::new(f1);
121121
///
122122
/// let f2 = reader.get_ref();
123123
/// # Ok(())
@@ -137,7 +137,7 @@ impl<R: Read> BufReader<R> {
137137
/// use std::fs::File;
138138
///
139139
/// # fn foo() -> std::io::Result<()> {
140-
/// let mut f1 = File::open("log.txt")?;
140+
/// let f1 = File::open("log.txt")?;
141141
/// let mut reader = BufReader::new(f1);
142142
///
143143
/// let f2 = reader.get_mut();
@@ -158,8 +158,8 @@ impl<R: Read> BufReader<R> {
158158
/// use std::fs::File;
159159
///
160160
/// # fn foo() -> std::io::Result<()> {
161-
/// let mut f1 = File::open("log.txt")?;
162-
/// let mut reader = BufReader::new(f1);
161+
/// let f1 = File::open("log.txt")?;
162+
/// let reader = BufReader::new(f1);
163163
///
164164
/// let f2 = reader.into_inner();
165165
/// # Ok(())

0 commit comments

Comments
 (0)