Struct Binder

pub struct Binder<A, S> { /* private fields */ }
Expand description

Only “useful” public Socks5Binder implementation, which actually is able to accept bind requests and process them.

The Default implementation opens a new socket for accepting 1 incoming connection. Once received it will pipe the original request (source) stream together with the received inbound stream from the secondary callee.

You can customise the Binder fully by creating it using Binder::new or overwrite any of the default components using either or both of Binder::with_acceptor and Binder::with_service.

Implementations§

§

impl<A, S> Binder<A, S>

pub fn new(acceptor: A, service: S) -> Binder<A, S>

Create a new Binder.

In case you only wish to overwrite one of these components you can also use a Default Binder and overwrite the specific component using Binder::with_acceptor or Binder::with_service.

§

impl<A, S> Binder<A, S>

pub fn with_acceptor<T>(self, acceptor: T) -> Binder<T, S>

Overwrite the Binder’s [AcceptorFactory], used to open a listener, return the address and wait for an incoming connection which it will return.

pub fn with_service<T>(self, service: T) -> Binder<A, T>

Overwrite the Binder’s Service used to actually do the proxy between the source and incoming bind Stream.

Any Service can be used as long as it has the signature:

(Context, ProxyRequest) -> ((), Into<BoxError>)

pub fn set_bind_interface( &mut self, interface: impl Into<Interface>, ) -> &mut Binder<A, S>

Define the (network) Interface to bind to.

By default it will use the client’s requested bind address, which is in many cases not what you want.

pub fn set_default_bind_interface(&mut self) -> &mut Binder<A, S>

Define the default (network) Interface to bind to (0.0.0.0:0).

By default it will use the client’s requested bind address, which is in many cases not what you want.

pub fn with_bind_interface( self, interface: impl Into<Interface>, ) -> Binder<A, S>

Define the (network) Interface to bind to.

By default it will use the client’s requested bind address, which is in many cases not what you want.

pub fn with_default_bind_interface(self) -> Binder<A, S>

Define the default (network) Interface to bind to (0.0.0.0:0).

By default it will use the client’s requested bind address, which is in many cases not what you want.

pub fn set_accept_timeout( &mut self, accept_timeout: Duration, ) -> &mut Binder<A, S>

Set field with Some(value)

pub fn with_accept_timeout(self, accept_timeout: Duration) -> Binder<A, S>

Replace field with Some(value)

pub fn maybe_with_accept_timeout( self, accept_timeout: Option<Duration>, ) -> Binder<A, S>

Replace field with the provided option

Trait Implementations§

§

impl<A, S> Clone for Binder<A, S>
where A: Clone, S: Clone,

§

fn clone(&self) -> Binder<A, S>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl<A, S> Debug for Binder<A, S>
where A: Debug, S: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl Default for Binder<Timeout<DefaultAcceptorFactory, LayerErrorStatic<Elapsed>>, StreamForwardService>

§

impl<S, F, StreamService> Socks5BinderSeal<S> for Binder<F, StreamService>
where S: Stream + Unpin, F: SocketService, <F as SocketService>::Socket: Acceptor, <<F as SocketService>::Socket as Acceptor>::Stream: Unpin, StreamService: Service<ProxyRequest<S, <<F as SocketService>::Socket as Acceptor>::Stream>, Response = ()>, <StreamService as Service<ProxyRequest<S, <<F as SocketService>::Socket as Acceptor>::Stream>>>::Error: Into<Box<dyn Error + Sync + Send>>,

§

async fn accept_bind( &self, ctx: Context, stream: S, requested_bind_address: Authority, ) -> Result<(), Error>

Auto Trait Implementations§

§

impl<A, S> Freeze for Binder<A, S>
where A: Freeze, S: Freeze,

§

impl<A, S> RefUnwindSafe for Binder<A, S>

§

impl<A, S> Send for Binder<A, S>
where A: Send, S: Send,

§

impl<A, S> Sync for Binder<A, S>
where A: Sync, S: Sync,

§

impl<A, S> Unpin for Binder<A, S>
where A: Unpin, S: Unpin,

§

impl<A, S> UnwindSafe for Binder<A, S>
where A: UnwindSafe, S: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

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
Source§

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

§

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

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

§

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

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<S, C> Socks5Binder<S> for C
where C: Socks5BinderSeal<S>,