Struct virtual_fs::special_file::DeviceFile

pub struct DeviceFile { /* private fields */ }

A “special” file is a file that is locked to one file descriptor (i.e. stdout => 0, stdin => 1), etc.

Implementations

impl DeviceFile

pub const STDIN: Fd = 0u32

pub const STDOUT: Fd = 1u32

pub const STDERR: Fd = 2u32

pub fn new(fd: Fd) -> Self

Trait Implementations

impl AsyncRead for DeviceFile

fn poll_read( self: Pin<&mut Self>, _cx: &mut Context<'_>, _buf: &mut ReadBuf<'_> ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncSeek for DeviceFile

fn start_seek(self: Pin<&mut Self>, _position: SeekFrom) -> Result<()>

Attempts to seek to an offset, in bytes, in a stream.

fn poll_complete( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<u64>>

Waits for a seek operation to complete.

impl AsyncWrite for DeviceFile

fn poll_write( self: Pin<&mut Self>, _cx: &mut Context<'_>, buf: &[u8] ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, _cx: &mut Context<'_>, bufs: &[IoSlice<'_>] ) -> Poll<Result<usize>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Debug for DeviceFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl VirtualFile for DeviceFile

fn last_accessed(&self) -> u64

the last time the file was accessed in nanoseconds as a UNIX timestamp

fn last_modified(&self) -> u64

the last time the file was modified in nanoseconds as a UNIX timestamp

fn created_time(&self) -> u64

the time at which the file was created in nanoseconds as a UNIX timestamp

fn size(&self) -> u64

the size of the file in bytes

fn set_len(&mut self, _new_size: u64) -> Result<()>

Change the size of the file, if the new_size is greater than the current size the extra bytes will be allocated and zeroed

fn unlink(&mut self) -> Result<()>

Request deletion of the file

fn get_special_fd(&self) -> Option<u32>

Used for “special” files such as stdin, stdout and stderr. Always returns the same file descriptor (0, 1 or 2). Returns None on normal files

fn poll_read_ready( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<usize>>

Polls the file for when there is data to be read

fn poll_write_ready( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<usize>>

Polls the file for when it is available for writing

fn is_open(&self) -> bool

Indicates if the file is opened or closed. This function must not block Defaults to a status of being constantly open