Module socket

Source
Expand description

Common types and utilities for sockets.

Structs§

AddrIsMappedError
The addr could not be converted to a NonMappedAddr.
AddrVecIter
An iterator over socket addresses.
BoundSocketMap
A map from socket addresses to sockets.
ConnAddr
The address of a connected socket.
DualStackTuple
A tuple of values for T for both I and I::OtherVersion.
IncompatibleError
Error returned by implementations of SocketMapAddrStateSpec to indicate incompatible changes to a socket map.
ListenerAddr
The address of a listening socket.
ListenerAddrInfo
Information about the address in a ListenerAddr.
ListenerIpAddr
The IP address and identifier (port) of a listening socket.
NotDualStackCapableError
An error encountered when attempting to perform dual stack operations on socket with a non dual stack capable protocol.
SendBufferFullError
An error indicating that the send buffer is full.
SendBufferSpace
A type stating that some amount of space was reserved within a SendBufferTracking instance.
SendBufferTracking
Tracks the available send buffer space for a socket.
Shutdown
Describes which direction(s) of the data path should be shut down.
SocketDeviceUpdate
A helper type to verify if applying socket updates is allowed for a given current state.
SocketDeviceUpdateNotAllowedError
The device can’t be updated on a socket.
SocketIpAddr
An IP address that witnesses all required properties of a socket address.
SocketStateEntry
A borrowed state entry in a SocketMap.
StrictlyZonedAddr
A ZonedAddr whose address is Zoned iff a zone is required.
UpdateSharingError
The error returned when updating the sharing state for a SocketMap entry fails.

Enums§

AddrEntry
A borrowed entry in a BoundSocketMap.
AddrVec
An “address vector” type that can hold any address in a SocketMap.
Bound
A bound socket state that is either a listener or a connection.
DualStackConnIpAddr
The IP address and identifiers (ports) of a dual-stack connected socket.
DualStackListenerIpAddr
The IP address and identifier (port) of a dual-stack listening socket.
DualStackLocalIp
A local IP address that’s either in the current stack or the other stack.
DualStackRemoteIp
A remote IP address that’s either in the current stack or the other stack.
EitherStack
State belonging to either IP stack.
FoundSockets
The type returned by BoundSocketMap::iter_receivers.
InsertError
Errors observed by SocketMapConflictPolicy.
Listener
Uninstantiable tag type for denoting listening sockets.
MaybeDualStack
Control flow type containing either a dual-stack or non-dual-stack context.
RemoveResult
The result of attempting to remove a socket from a collection of sockets.
SetDualStackEnabledError
An error encountered while enabling or disabling dual-stack operation.
ShutdownType
Which direction(s) to shut down for a socket.
SocketAddrType
How a socket is bound on the system.

Traits§

DualStackIpExt
A dual stack IP extention trait that provides the OtherVersion associated type.
Inserter
An inserter into a SocketMap.
SocketIpAddrExt
Extensions to IP Address witnesses useful in the context of sockets.
SocketIpExt
Extension trait for Ip providing socket-specific functionality.
SocketMapAddrSpec
Specification for the identifiers in an AddrVec.
SocketMapAddrStateSpec
Describes an entry in a SocketMap for a listener or connection address.
SocketMapAddrStateUpdateSharingSpec
Provides behavior on updating the sharing state of a SocketMap entry.
SocketMapConflictPolicy
Provides conflict detection for a SocketMapStateSpec.
SocketMapStateSpec
Specifies the types parameters for BoundSocketMap state as a single bundle.
SocketMapUpdateSharingPolicy
Defines the policy for updating the sharing state of entries in the SocketMap.
SocketWritableListener
A type capable of handling socket writable changes.
SocketZonedAddrExt
An extention trait for ZonedAddr.

Type Aliases§

ConnInfoAddr
The IP addresses (mapped if dual-stack) and identifiers (ports) of a connected socket.
ConnIpAddr
The IP addresses and identifiers (ports) of a connected socket.