camino-tempfile

Crates.iocamino-tempfile
lib.rscamino-tempfile
version1.1.1
sourcesrc
created_at2023-04-24 00:21:47.224912
updated_at2023-11-28 02:45:58.419831
descriptionA library for managing temporary files and directories, with UTF-8 paths.
homepage
repositoryhttps://github.com/camino-rs/camino-tempfile
max_upload_size
id846941
size111,107
Rain (sunshowers)

documentation

https://docs.rs/camino-tempfile

README

camino-tempfile

camino-tempfile on crates.io Documentation (latest release) Documentation (main) License License

A secure, cross-platform, temporary file library for Rust with UTF-8 paths.

This crate is a wrapper around tempfile that works with the Utf8Path and Utf8PathBuf types defined by camino. If your code mostly uses camino, it can be annoying to have to convert temporary paths to Utf8Path over and over again. This crate manages that for you.

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

Usage

Minimum required Rust version: 1.63.0

Add this to your Cargo.toml:

[dependencies]
camino-tempfile = "1"

Example

use std::fs::File;
use std::io::{Write, Read, Seek, SeekFrom};

fn main() {
    // Write
    let mut tmpfile: File = camino_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);
}

License

This project is available under the terms of either the Apache 2.0 license or the MIT license.

Portions copied and adapted from tempfile and used under the MIT and Apache 2.0 licenses. tempfile is copyright 2015 Steven Allen and the tempfile authors.

Commit count: 24

cargo fmt