Module common

Source

Macros§

header
Generates a new Header of key/value pairs based on literals.
map
Generates a new Map of key/value pairs based on literals.

Structs§

Backup
Stores Frames for reuse later.
ChainCodec
Represents a codec that chains together other codecs such that encoding will call the encode methods of the underlying, chained codecs from left-to-right and decoding will call the decode methods in reverse order
Destination
distant connects and logs into the specified destination, which may be specified as either hostname:port where an attempt to connect to a distant server will be made, or a URI of one of the following forms:
Frame
Represents some data wrapped in a frame in order to ship it over the network. The format is simple and follows {len}{item} where len is the length of the item as a u64.
FramedTransport
Represents a wrapper around a Transport that reads and writes using frames defined by a Codec.
Header
Represents a packet header comprised of arbitrary data tied to string keys.
HeapSecretKey
Represents a secret key used with transport encryption and authentication that is stored on the heap
InmemoryTransport
Represents a Transport comprised of two inmemory channels
Interest
Readiness event interest.
KeyExchange
Utility to support performing an exchange of public keys and salts in order to derive a shared key between two separate entities
Keychain
Manages keys with associated ids. Cloning will result in a copy pointing to the same underlying storage, which enables support of managing the keys across multiple threads.
Map
Contains map information for connections and other use cases
MappedListener
Represents a Listener that wraps a different Listener, mapping the received connection to something else using the map function
MpscListener
Represents a Listener that uses an mpsc::Receiver to accept new connections
OneshotListener
Represents a Listener that only has a single connection
PlainCodec
Represents a codec that does not alter the frame (synonymous with “plain text”)
PortRange
Represents some range of ports
PredicateCodec
Represents a codec that invokes one of two codecs based on the given predicate
PublicKeyBytes
Represents a wrapper around EncodedPoint, and exists to fix an issue with serde deserialization failing when directly serializing the EncodedPoint type
Ready
Describes the readiness state of an I/O resources.
Request
Represents a request to send
Response
Represents a response received related to some response
Salt
Friendly wrapper around a 32-byte array representing a salt
SecretKey
Represents a secret key used with transport encryption and authentication
SecretKeyError
TcpListener
Represents a Listener for incoming connections over TCP
TcpTransport
Represents a Transport that leverages a TCP stream
UnixSocketListener
Represents a Listener for incoming connections over a Unix socket
UnixSocketTransport
Represents a Transport that leverages a Unix socket
UntypedRequest
Represents a request to send whose payload is bytes instead of a specific type
UntypedResponse
Represents a response to send whose payload is bytes instead of a specific type
Value
Generic value type for data passed through header.
Version
Represents a version and compatibility rules.

Enums§

CompressionCodec
Represents a codec that applies compression during encoding and decompression during decoding of a frame’s item
CompressionLevel
Represents the level of compression to apply to data
CompressionType
Represents the type of compression for a CompressionCodec
EncryptionCodec
Represents the codec that encodes & decodes frames by encrypting/decrypting them
EncryptionType
Represents the type of encryption for a EncryptionCodec
Handshake
Definition of the handshake to perform for a transport
Host
Represents the host of a destination
HostParseError
KeychainResult
Represents the result of a request to the database.
MapParseError
UntypedRequestParseError
Error encountered when attempting to parse bytes as an untyped request
UntypedResponseParseError
Error encountered when attempting to parse bytes as an untyped response

Traits§

AsAny
Trait used for casting support into the Any trait object
Codec
Represents abstraction that implements specific encoder and decoder logic to transform an arbitrary collection of bytes. This can be used to encrypt and authenticate bytes sent and received by transports.
CodecExt
Interface that provides extensions to the codec interface
Listener
Represents a type that has a listen interface for receiving raw streams
Reconnectable
Interface representing a connection that is reconnectable.
Transport
Interface representing a transport of raw bytes into and out of the system.
TransportExt

Type Aliases§

BoxedCodec
Represents a Boxed version of Codec
ConnectionId
Id of the connection
Id
Represents a generic id type
OwnedFrame
Represents a frame whose lifetime is static
SecretKey16
Represents a 16-byte (128-bit) secret key
SecretKey24
Represents a 24-byte (192-bit) secret key
SecretKey32
Represents a 32-byte (256-bit) secret key