Skip to main content

ServeContext

Struct ServeContext 

Source
pub struct ServeContext {
    pub vps_name: String,
    pub local_port: u16,
    pub timeout_ms: u64,
    pub json: bool,
    pub bind_addr: String,
    pub bound_flag: Option<Arc<AtomicBool>>,
    pub stats: Option<Arc<TunnelStats>>,
}
Expand description

Everything an already-connected client needs to serve one tunnel, minus the mode-specific destination.

§Why a struct (B3)

The three serve entry points below took nine and ten positional parameters, with u16, u64 and bool sitting next to each other. local_port and remote_port are both u16; swapping them compiles and binds the wrong side of the tunnel. The one lint that measures this — too_many_arguments — was suppressed on all three, so nothing reported it.

Fields§

§vps_name: String

Registry name of the relay host.

§local_port: u16

Local port to bind (0 = OS-assigned).

§timeout_ms: u64

Mandatory deadline in milliseconds.

§json: bool

Agent-first JSON output.

§bind_addr: String

Local bind address.

§bound_flag: Option<Arc<AtomicBool>>

Set once the listener is bound (readiness handshake for callers).

§stats: Option<Arc<TunnelStats>>

Lifetime counters published in the tunnel_closed event.

Auto Trait Implementations§

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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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