rust-fstream (fstream) - v0.1.2

A simple library to read/write files more easily in Rust.

Examples

Write text to a file.

match fstream::write_text("test_file.txt", "Hello world!", true) {

  Some(b) => println!("Number of bytes written to the file: {}", b),
  
  None => println!("Couldn't open or write to the file!"),
  
}

or just:

fstream::write_text("test_file.txt", "Hello world!", true).unwrap();

Read text from a file.

match fstream::read_text("test_file.txt") {

  Some(s) => println!("File content: {}", s),
        
  None => println!("Couldn't open or read the file"),
        
}

or just:

fstream::read_text("test_file.txt").unwrap();

Functions

Read

Function	Description
read	Reads file content into a buffer
read_text	Reads text from a file as a string
read_lines	Reads text from a file and stores lines into a vector of strings
read_words	Reads text from a file and stores words into a vector of strings
read_delim	Reads text from a file, splits it using a user specified delimiter and stores the tokens into a vector of strings

Write

Function	Description
write	Writes a buffer to a file
write_text	Writes a string to a file
write_lines	Writes a vector of strings to a file as lines
write_fmt	Writes formatted text to a file
write_newline	Writes a new line to a file

Utils

Function	Description
contains	Checks if a file contains a substring
merge	Merges the second file into the first one

Installation

Add this line to your Cargo.toml:

[dependencies]
fstream = "0.1.2"

and then add this line to your main.rs:

extern crate fstream;