Skip to main content

## FileHandle

# Struct FileHandle

Source

    pub struct FileHandle {
        pub(crate) file: File,
        pub(crate) writable: bool,
    }

## Fields§

§`file: File`§`writable: bool`

## Trait Implementations§

Source§

### impl Debug for FileHandle

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl FileDescription for FileHandle

Source§

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

Source§

#### 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. Read more
Source§

#### 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. Read more
Source§

#### 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.
Source§

#### fn destroy<'tcx>( self, _self_id: FdId, communicate_allowed: bool, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<()>>

Destroys the file description. Only called when the last duplicate file descriptor is closed. Read more
Source§

#### fn metadata<'tcx>( &self, ) -> InterpResult<'tcx, Either<Result<Metadata>, &'static str>>

Returns the metadata for this FD, if available. This is either host metadata, or a non-file-backed-FD type. The latter is for new represented as a string storing a `libc` name so we only support that kind of metadata on Unix targets.
Source§

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

Source§

#### fn short_fd_operations(&self) -> bool

Determines whether this FD non-deterministically has its reads and writes shortened.
Source§

#### fn as_unix<'tcx>(&self, ecx: &MiriInterpCx<'tcx>) -> &dyn UnixFileDescription

Source§

#### fn get_flags<'tcx>( &self, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Scalar>

Implementation of fcntl(F_GETFL) for this FD.
Source§

#### fn set_flags<'tcx>( &self, _flag: i32, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Scalar>

Implementation of fcntl(F_SETFL) for this FD.
Source§

### impl UnixFileDescription for FileHandle

Source§

#### fn pread<'tcx>( &self, communicate_allowed: bool, offset: u64, 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` from a given offset. `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.
Source§

#### fn pwrite<'tcx>( &self, communicate_allowed: bool, ptr: Pointer, len: usize, offset: u64, ecx: &mut MiriInterpCx<'tcx>, finish: DynMachineCallback<'tcx, Result<usize, IoError>>, ) -> InterpResult<'tcx>

Writes as much as possible from the given buffer `ptr` starting at a given offset. `ptr` is the pointer to the user supplied read buffer. `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.
Source§

#### fn flock<'tcx>( &self, communicate_allowed: bool, op: FlockOp, ) -> InterpResult<'tcx, Result<()>>

Source§

#### fn ioctl<'tcx>( &self, _op: Scalar, _arg: Option<&OpTy<'tcx>>, _ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, i32>

Modifies device parameters. `op` is the device-dependent operation code. It’s either a `c_long` or `c_int`, depending on the target and whether it uses glibc or musl. `arg` is the optional third argument which exists depending on the operation code. It’s either an integer or a pointer.
Source§

#### fn epoll_active_events<'tcx>(&self) -> InterpResult<'tcx, EpollEvents>

Return which epoll events are currently active.

## Auto Trait Implementations§

§

### impl Freeze for FileHandle

§

### impl RefUnwindSafe for FileHandle

§

### impl Send for FileHandle

§

### impl Sync for FileHandle

§

### impl Unpin for FileHandle

§

### impl UnsafeUnpin for FileHandle

§

### impl UnwindSafe for FileHandle

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> FileDescriptionExt for T
where T: FileDescription + 'static,

Source§

#### fn into_rc_any(self: FileDescriptionRef<T>) -> Rc<dyn Any>

Source§

#### fn close_ref<'tcx>( self: FileDescriptionRef<T>, communicate_allowed: bool, ecx: &mut InterpCx<'tcx, MiriMachine<'tcx>>, ) -> InterpResult<'tcx, Result<(), Error>>

We wrap the regular `close` function generically, so both handle `Rc::into_inner` and epoll interest management.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes