# Functions
No description provided by the author
No description provided by the author
CheckUnackedParams ensures that all parameters in params are either acknowledged by being associated with a true value in ackedParams or are optional due to being suffixed with a question mark.
DefEndpointParams returns most of a 'stock' set of endpoint parameters.
No description provided by the author
LoadServerPrivateFile loads server private identity information from path.
ModelAvailable returns true iff a shaping model with the given name has been registered with the Dust package.
ModelsAvailable returns a list of all registered model type names, in no particular order.
NewServerPrivate generates a new server private identity suitable for the given endpoint parameters.
No description provided by the author
No description provided by the author
No description provided by the author
RegisterModel registers that models of the type named by name can be constructed by using constructor.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
TODO: use some error from net?.
No description provided by the author
TODO: support deadlines, of course.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
EndpointParams represents all the preagreed parameters needed to establish the "same kind" of Dust connection between two endpoints, excluding endpoint-specific identity material.
ModelSpec represents the name of a model to use for an endpoint, plus unparsed model-specific parameters.
ParameterError describes a problem relating to a specific data element.
No description provided by the author
ServerPrivate represents the private identity of a Dust server.
ServerPublic represents the public identity of a Dust server.
# Interfaces
ShapingCodec is a convenience type mostly for internal use by model implementations.
ShapingModel provides a way of initializing encoder/decoder pairs for either side of a Dust connection using the model.
Socket provides the underlying "visible" transport for a single Dust connection.
# Type aliases
No description provided by the author
ParameterErrorHow describes whether the data element referenced in a ParameterError is missing, unexpected (present but without a known interpretation), or invalid (present when expected but with an uninterpretable value).
See the shaping package for the definitions of Encoder and Decoder.
See the shaping package for the definitions of Encoder and Decoder.
ShapingModelConstructor takes a map of parameters and builds a suitable ShapingModel from which encoders and decoders can be initialized.