Struct Socket 

struct Socket {
    family: SocketFamily,
    state: RefCell<SocketState>,
    is_non_block: Cell<bool>,
    io_readiness: RefCell<BlockingIoSourceReadiness>,
    error: RefCell<Option<Error>>,
    read_timeout: Cell<Option<Duration>>,
    write_timeout: Cell<Option<Duration>>,
}

Fields

family: SocketFamily

Family of the socket, used to ensure socket only binds/connects to address of same family.

state: RefCell<SocketState>

Current state of the inner socket.

is_non_block: Cell<bool>

Whether this fd is non-blocking or not.

io_readiness: RefCell<BlockingIoSourceReadiness>

The current blocking I/O readiness of the file description.

error: RefCell<Option<Error>>

Some when the socket had an async error which has not yet been fetched via SO_ERROR.

read_timeout: Cell<Option<Duration>>

Read timeout of the socket. None means that reads can block indefinitely. The timeout is applied to the monotonic clock (the Unix specification doesn’t specify which clock to use, but the monotonic clock is more common for relative timeouts). This is ignored when the socket is non-blocking.

write_timeout: Cell<Option<Duration>>

Write timeout of the socket. None means that writes can block indefinitely. The timeout is applied to the monotonic clock (the Unix specification doesn’t specify which clock to use, but the monotonic clock is more common for relative timeouts). This is ignored when the socket is non-blocking.

Trait Implementations

impl Debug for Socket

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

Formats the value using the given formatter.

impl FileDescription for Socket

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

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.

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.

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.

fn short_fd_operations(&self) -> bool

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

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

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

Implementation of fcntl(F_GETFL) for this FD.

fn set_flags<'tcx>( &self, flag: i32, ecx: &mut MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Scalar>

Implementation of fcntl(F_SETFL) for this FD.

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 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.

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

impl SourceFileDescription for Socket

fn with_source( &self, f: &mut dyn FnMut(&mut dyn Source) -> Result<()>, ) -> Result<()>

Invoke f on the source inside self.

fn get_readiness_mut(&self) -> RefMut<'_, BlockingIoSourceReadiness>

Get a mutable reference to the readiness of the source.

impl UnixFileDescription for Socket

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.

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

Return which epoll events are currently active.

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.

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.

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

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: 112 bytes