https://github.com/Rufflewind/tokio-file-unix

Asynchronous support for epollable files via Tokio on Unix-like platforms
https://github.com/Rufflewind/tokio-file-unix

asynchronous file io posix rust

Last synced: 3 months ago
JSON representation

Asynchronous support for epollable files via Tokio on Unix-like platforms

• Host: GitHub
• URL: https://github.com/Rufflewind/tokio-file-unix
• Owner: Rufflewind
• License: apache-2.0
• Archived: true
• Created: 2017-02-05T13:04:50.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-06-06T07:55:13.000Z (over 3 years ago)
• Last Synced: 2024-10-12T21:59:42.146Z (4 months ago)
• Topics: asynchronous, file, io, posix, rust
• Language: Rust
• Homepage: https://docs.rs/tokio-file-unix
• Size: 50.8 KB
• Stars: 34
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# `tokio-file-unix`

[![Documentation](https://docs.rs/tokio-file-unix/badge.svg)](https://docs.rs/tokio-file-unix)

[![Crates.io](https://img.shields.io/crates/v/tokio-file-unix.svg)](https://crates.io/crates/tokio-file-unix)

[![Build Status](https://github.com/Rufflewind/tokio-file-unix/actions/workflows/build.yml/badge.svg)](https://github.com/Rufflewind/tokio-file-unix/actions/workflows/build.yml)

Asynchronous support for file-like objects via [Tokio](https://tokio.rs).  **Only supports Unix-like platforms.**

This crate is primarily intended for pipes and other files that support nonblocking I/O.  Regular files do not support nonblocking I/O, so this crate has no effect on them.

## Usage

Add this to your `Cargo.toml`:

~~~toml

[dependencies]

tokio-file-unix = "0.5.1"

~~~

Next, add this to the root module of your crate:

~~~rust

extern crate tokio_file_unix;

~~~

## Examples

See the `examples` directory as well as the documentation.

## License

Dual-licensed under Apache and MIT.