Struct tokio_file_unix::File
[−]
[src]
pub struct File(pub File);
A thin wrapper over std::fs::File
that adds support for mio::Evented
.
You should construct it using File::new_nb
unless you're certain the
underlying file descriptor has been set to nonblocking mode.
Example: creating a File
for standard input:
tokio_file_unix::File::new_nb(std::fs::File::open("/dev/stdin")?)
Methods
impl File
[src]
fn new_nb(file: File) -> Result<Self>
Wraps an existing std::fs::File
and enables nonblocking mode.
This modifies the flags of the underlying file descriptor.
fn into_io(self, handle: &Handle) -> Result<PollEvented<Self>>
Converts into a pollable object that supports std::io::Read
,
std::io::Write
, and tokio_core::io::Io
, suitable for the
tokio_core::io::*
functions.
fn into_reader(self, handle: &Handle) -> Result<BufReader<PollEvented<Self>>>
Converts into a pollable object that supports std::io::Read
and
std::io::ReadBuf
, suitable for the tokio_core::io::read_*
functions.
Trait Implementations
impl Debug for File
[src]
impl Evented for File
[src]
fn register(&self,
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt)
-> Result<()>
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt)
-> Result<()>
fn reregister(&self,
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt)
-> Result<()>
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt)
-> Result<()>
fn deregister(&self, poll: &Poll) -> Result<()>
impl Read for File
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0
Transforms this Read
instance to an Iterator
over its bytes. Read more
fn chars(self) -> Chars<Self>
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an Iterator
over char
s. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read
1.0.0
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0
Creates an adaptor which will read at most limit
bytes from it. Read more
impl Write for File
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Write
. Read more