diff options
Diffstat (limited to 'vendor/tempfile/README.md')
-rw-r--r-- | vendor/tempfile/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/vendor/tempfile/README.md b/vendor/tempfile/README.md new file mode 100644 index 000000000..5b8fb3829 --- /dev/null +++ b/vendor/tempfile/README.md @@ -0,0 +1,46 @@ +tempfile +======== + +[![Crate](https://img.shields.io/crates/v/tempfile.svg)](https://crates.io/crates/tempfile) +[![Build Status](https://travis-ci.org/Stebalien/tempfile.svg?branch=master)](https://travis-ci.org/Stebalien/tempfile) +[![Build status](https://ci.appveyor.com/api/projects/status/5q00b8rvvg46i5tf/branch/master?svg=true)](https://ci.appveyor.com/project/Stebalien/tempfile/branch/master) + +A secure, cross-platform, temporary file library for Rust. In addition to creating +temporary files, this library also allows users to securely open multiple +independent references to the same temporary file (useful for consumer/producer +patterns and surprisingly difficult to implement securely). + +[Documentation](https://docs.rs/tempfile/) + +Usage +----- + +Minimum required Rust version: 1.40.0 + +Add this to your `Cargo.toml`: +```toml +[dependencies] +tempfile = "3" +``` + +Example +------- + +```rust +use std::fs::File; +use std::io::{Write, Read, Seek, SeekFrom}; + +fn main() { + // Write + let mut tmpfile: File = tempfile::tempfile().unwrap(); + write!(tmpfile, "Hello World!").unwrap(); + + // Seek to start + tmpfile.seek(SeekFrom::Start(0)).unwrap(); + + // Read + let mut buf = String::new(); + tmpfile.read_to_string(&mut buf).unwrap(); + assert_eq!("Hello World!", buf); +} +``` |