Trait FileDescription

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

    // Provided methods
    fn read<'tcx>(
        self: FileDescriptionRef<Self>,
        _communicate_allowed: bool,
        _ptr: Pointer,
        _len: usize,
        _ecx: &mut MiriInterpCx<'tcx>,
        _finish: DynMachineCallback<'tcx, Result<usize, IoError>>,
    ) -> InterpResult<'tcx> { ... }
    fn write<'tcx>(
        self: FileDescriptionRef<Self>,
        _communicate_allowed: bool,
        _ptr: Pointer,
        _len: usize,
        _ecx: &mut MiriInterpCx<'tcx>,
        _finish: DynMachineCallback<'tcx, Result<usize, IoError>>,
    ) -> InterpResult<'tcx> { ... }
    fn seek<'tcx>(
        &self,
        _communicate_allowed: bool,
        _offset: SeekFrom,
    ) -> InterpResult<'tcx, Result<u64>> { ... }
    fn close<'tcx>(
        self,
        _communicate_allowed: bool,
        _ecx: &mut MiriInterpCx<'tcx>,
    ) -> InterpResult<'tcx, Result<()>>
       where Self: Sized { ... }
    fn metadata<'tcx>(&self) -> InterpResult<'tcx, Result<Metadata>> { ... }
    fn is_tty(&self, _communicate_allowed: bool) -> bool { ... }
    fn as_unix(&self) -> &dyn UnixFileDescription { ... }
}

Represents an open file description.

Required Methods

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

Provided Methods

fn read<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _ptr: Pointer, _len: usize, _ecx: &mut MiriInterpCx<'tcx>, _finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Reads as much as possible into the given buffer ptr. len indicates how many bytes we should try to read. dest is where the return value should be stored: number of bytes read, or -1 in case of error.

fn write<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, _ptr: Pointer, _len: usize, _ecx: &mut MiriInterpCx<'tcx>, _finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Writes as much as possible from the given buffer ptr. len indicates how many bytes we should try to write. dest is where the return value should be stored: number of bytes written, or -1 in case of error.

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, _communicate_allowed: bool, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<()>>

where Self: Sized,

Close the file descriptor.

fn metadata<'tcx>(&self) -> InterpResult<'tcx, Result<Metadata>>

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

fn as_unix(&self) -> &dyn UnixFileDescription

Implementations on Foreign Types

impl FileDescription for Stderr

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

fn write<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, ptr: Pointer, len: usize, ecx: &mut MiriInterpCx<'tcx>, finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

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

impl FileDescription for Stdin

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

fn read<'tcx>( self: FileDescriptionRef<Self>, communicate_allowed: bool, ptr: Pointer, len: usize, ecx: &mut MiriInterpCx<'tcx>, finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

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

impl FileDescription for Stdout

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

fn write<'tcx>( self: FileDescriptionRef<Self>, _communicate_allowed: bool, ptr: Pointer, len: usize, ecx: &mut MiriInterpCx<'tcx>, finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

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

Implementors

impl FileDescription for FileHandle

impl FileDescription for Epoll

impl FileDescription for EventFd

impl FileDescription for AnonSocket

impl FileDescription for NullOutput