Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaced "non-efficient" implementation #1681

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions src/std_misc/file/read_lines.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,38 @@
# `read_lines`

## Beginner friendly method

This method is NOT efficient. It's here for beginners
who can't understand the efficient method yet.

```rust,no_run
use std::fs::File;
use std::io::{ self, BufRead, BufReader };
use std::io::Read;

fn read_lines(filename: String) -> io::Lines<BufReader<File>> {
fn read_lines(filename: String) -> Vec<String> {
// Open the file in read-only mode.
let file = File::open(filename).unwrap();
// Read the file line by line, and return an iterator of the lines of the file.
return io::BufReader::new(file).lines();
let mut file = File::open(filename).unwrap();

// Read file contents into a String buffer.
let mut buffer = String::new();
file.read_to_string(&mut buffer).unwrap();

// Parse the buffer line by line, and collect into a `Vec<String>`
buffer.lines().map(|line| line.to_owned()).collect()
}

fn main() {
// Stores the iterator of lines of the file in lines variable.
// Stores a Vector of lines of the file in lines variable.
let lines = read_lines("./hosts".to_string());
// Iterate over the lines of the file, and in this case print them.
for line in lines {
println!("{}", line.unwrap());
println!("{}", line);
}
}
```

Running this program simply prints the lines individually.

```shell
$ echo -e "127.0.0.1\n192.168.0.1\n" > hosts
$ rustc read_lines.rs && ./read_lines
Expand All @@ -34,10 +41,11 @@ $ rustc read_lines.rs && ./read_lines
```

## Efficient method

The method `lines()` returns an iterator over the lines
of a file.

`File::open` expects a generic, `AsRef<Path>`. That's what
`File::open` expects a generic, `AsRef<Path>`. That's what
`read_lines()` expects as input.

```rust,no_run
Expand Down Expand Up @@ -67,12 +75,13 @@ where P: AsRef<Path>, {
```

Running this program simply prints the lines individually.

```shell
$ echo -e "127.0.0.1\n192.168.0.1\n" > hosts
$ rustc read_lines.rs && ./read_lines
127.0.0.1
192.168.0.1
```

This process is more efficient than creating a `String` in memory
especially working with larger files.
This process is more efficient than creating a `String` in memory,
especially when working with larger files.