Trait miri::shims::unix::fd::FileDescription

pub trait FileDescription: Debug + Any {
    // Required method
    fn name(&self) -> &'static str;

    // Provided methods
    fn read<'tcx>(
        &self,
        _self_ref: &FileDescriptionRef,
        _communicate_allowed: bool,
        _bytes: &mut [u8],
        _ecx: &mut MiriInterpCx<'tcx>,
    ) -> InterpResult<'tcx, Result<usize>> { ... }
    fn write<'tcx>(
        &self,
        _self_ref: &FileDescriptionRef,
        _communicate_allowed: bool,
        _bytes: &[u8],
        _ecx: &mut MiriInterpCx<'tcx>,
    ) -> InterpResult<'tcx, Result<usize>> { ... }
    fn pread<'tcx>(
        &self,
        _communicate_allowed: bool,
        _bytes: &mut [u8],
        _offset: u64,
        _ecx: &mut MiriInterpCx<'tcx>,
    ) -> InterpResult<'tcx, Result<usize>> { ... }
    fn pwrite<'tcx>(
        &self,
        _communicate_allowed: bool,
        _bytes: &[u8],
        _offset: u64,
        _ecx: &mut MiriInterpCx<'tcx>,
    ) -> InterpResult<'tcx, Result<usize>> { ... }
    fn seek<'tcx>(
        &self,
        _communicate_allowed: bool,
        _offset: SeekFrom,
    ) -> InterpResult<'tcx, Result<u64>> { ... }
    fn close<'tcx>(
        self: Box<Self>,
        _communicate_allowed: bool,
        _ecx: &mut MiriInterpCx<'tcx>,
    ) -> InterpResult<'tcx, Result<()>> { ... }
    fn flock<'tcx>(
        &self,
        _communicate_allowed: bool,
        _op: FlockOp,
    ) -> InterpResult<'tcx, Result<()>> { ... }
    fn is_tty(&self, _communicate_allowed: bool) -> bool { ... }
    fn get_epoll_ready_events<'tcx>(
        &self,
    ) -> InterpResult<'tcx, EpollReadyEvents> { ... }
}

Represents an open file descriptor.

Required Methods

fn name(&self) -> &'static str

Provided Methods

fn read<'tcx>( &self, _self_ref: &FileDescriptionRef, _communicate_allowed: bool, _bytes: &mut [u8], _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<usize>>

Reads as much as possible into the given buffer, and returns the number of bytes read.

fn write<'tcx>( &self, _self_ref: &FileDescriptionRef, _communicate_allowed: bool, _bytes: &[u8], _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<usize>>

Writes as much as possible from the given buffer, and returns the number of bytes written.

fn pread<'tcx>( &self, _communicate_allowed: bool, _bytes: &mut [u8], _offset: u64, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<usize>>

Reads as much as possible into the given buffer from a given offset, and returns the number of bytes read.

fn pwrite<'tcx>( &self, _communicate_allowed: bool, _bytes: &[u8], _offset: u64, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<usize>>

Writes as much as possible from the given buffer starting at a given offset, and returns the number of bytes written.

fn seek<'tcx>( &self, _communicate_allowed: bool, _offset: SeekFrom, ) -> InterpResult<'tcx, Result<u64>>

Seeks to the given offset (which can be relative to the beginning, end, or current position). Returns the new position from the start of the stream.

fn close<'tcx>( self: Box<Self>, _communicate_allowed: bool, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<()>>

fn flock<'tcx>( &self, _communicate_allowed: bool, _op: FlockOp, ) -> InterpResult<'tcx, Result<()>>

fn is_tty(&self, _communicate_allowed: bool) -> bool

fn get_epoll_ready_events<'tcx>(&self) -> InterpResult<'tcx, EpollReadyEvents>

Check the readiness of file description.

Implementations

impl dyn FileDescription

pub fn downcast<T: Any>(&self) -> Option<&T>

Implementations on Foreign Types

impl FileDescription for Stderr

fn name(&self) -> &'static str

fn write<'tcx>( &self, _self_ref: &FileDescriptionRef, _communicate_allowed: bool, bytes: &[u8], _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<usize>>

fn is_tty(&self, communicate_allowed: bool) -> bool

impl FileDescription for Stdin

fn name(&self) -> &'static str

fn read<'tcx>( &self, _self_ref: &FileDescriptionRef, communicate_allowed: bool, bytes: &mut [u8], _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<usize>>

fn is_tty(&self, communicate_allowed: bool) -> bool

impl FileDescription for Stdout

fn name(&self) -> &'static str

fn write<'tcx>( &self, _self_ref: &FileDescriptionRef, _communicate_allowed: bool, bytes: &[u8], _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<usize>>

fn is_tty(&self, communicate_allowed: bool) -> bool

Implementors

impl FileDescription for FileHandle

impl FileDescription for Epoll

impl FileDescription for Event

impl FileDescription for AnonSocket

impl FileDescription for NullOutput