Struct tor_proto::channel::ChannelBuilder

source · [−]

pub struct ChannelBuilder { /* private fields */ }

Expand description

Structure for building and launching a Tor channel.

Implementations

impl ChannelBuilder

pub fn new() -> Self

Construct a new ChannelBuilder.

pub fn set_declared_addr(&mut self, target: SocketAddr)

Set the declared target address of this channel.

Note that nothing enforces the correctness of this address: it doesn’t have to match the real address target of the TLS stream. For now it is only used for logging.

pub fn launch<T, S>(
    self,
    tls: T,
    sleep_prov: S
) -> OutboundClientHandshake<T, S> where
    T: AsyncRead + AsyncWrite + Send + Unpin + 'static,
    S: SleepProvider,

Launch a new client handshake over a TLS stream.

After calling this function, you’ll need to call connect() on the result to start the handshake. If that succeeds, you’ll have authentication info from the relay: call check() on the result to check that. Finally, to finish the handshake, call finish() on the result of that.

Trait Implementations

impl Default for ChannelBuilder

fn default() -> ChannelBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for ChannelBuilder

impl Send for ChannelBuilder

impl Sync for ChannelBuilder

impl Unpin for ChannelBuilder

impl UnwindSafe for ChannelBuilder

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more