Struct StreamParameters

pub struct StreamParameters {
    ip_version: IpVersionPreference,
    optimistic: bool,
    suppress_hostname: bool,
    suppress_begin_flags: bool,
}

A set of preferences used to declare how a new stream should be opened.

Fields

ip_version: IpVersionPreference

Preferred IP version to use.

optimistic: bool

True if we are requesting an optimistic stream.

suppress_hostname: bool

True if we are suppressing hostnames

suppress_begin_flags: bool

True if we are suppressing flags.

Implementations

impl StreamParameters

pub fn new() -> Self

Create a new StreamParameters using default settings.

pub fn suppress_begin_flags(&mut self) -> &mut Self

Configure this StreamParameters to include no flags in any BEGIN message it generates.

This is used to implement onion services. It may make other operations inoperable.

pub fn suppress_hostname(&mut self) -> &mut Self

Configure this StreamParameters to suppress hostnames in the BEGIN messages.

This is used to implement onion services. It will make other kinds of connections not work.

pub fn ip_version(&mut self, preference: IpVersionPreference) -> &mut Self

Configure which IP version (IPv4 or IPv6) you’d like to request, if you’re connecting to a hostname.

The default is to allow either version, but to prefer IPv4.

pub fn optimistic(&mut self, optimistic: bool) -> &mut Self

Configure whether the stream should be opened “optimistically.”

By default, streams are not “optimistic”. When you call ClientCirc::begin_stream(), the function won’t give you a stream until the exit node has confirmed that it has successfully opened a connection to your target address. It’s safer to wait in this way, but it is slower: it takes an entire round trip to get your confirmation.

If a stream is configured to be “optimistic”, then ClientCirc::begin_stream() will return the stream immediately, without waiting for an answer from the exit. You can start sending data on the stream right away, though of course this data will be lost if the connection is not actually successful.

pub(crate) fn is_optimistic(&self) -> bool

Crate-internal: Return true if the stream is optimistic.

pub(crate) fn begin_flags(&self) -> BeginFlags

Crate-internal: Get a set of [BeginFlags] for this stream.

pub(crate) fn suppressing_hostname(&self) -> bool

Crate-internal: Return true if we are suppressing hostnames.

Trait Implementations

impl Clone for StreamParameters

fn clone(&self) -> StreamParameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamParameters

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

Formats the value using the given formatter.

impl Default for StreamParameters

fn default() -> StreamParameters

Returns the “default value” for a type.