Struct ngrok::forwarder::Forwarder

source · 
pub struct Forwarder<T> { /* private fields */ }
Expand description

An ngrok forwarder.

Represents a tunnel that is being forwarded to a URL.

Implementations§

source§

impl<T> Forwarder<T>

source

pub fn join(&mut self) -> &mut JoinHandle<Result<(), Error>>

Wait for the forwarding task to exit.

Trait Implementations§

source§

impl<T> EdgeInfo for Forwarder<T>
where T: EdgeInfo,

source§

fn labels(&self) -> &HashMap<String, String>

Returns the labels that the tunnel was started with.
source§

impl<T> EndpointInfo for Forwarder<T>
where T: EndpointInfo,

source§

fn proto(&self) -> &str

Returns the protocol of the tunnel’s endpoint.
source§

fn url(&self) -> &str

Returns the tunnel endpoint’s URL.
source§

impl<T> TunnelCloser for Forwarder<T>
where T: TunnelCloser + Send,

source§

fn close<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Close the tunnel. Read more
source§

impl<T> TunnelInfo for Forwarder<T>
where T: TunnelInfo,

source§

fn id(&self) -> &str

Returns a tunnel’s unique ID.
source§

fn forwards_to(&self) -> &str

Returns a human-readable string presented in the ngrok dashboard and the Tunnels API. Use the HttpTunnelBuilder::forwards_to, TcpTunnelBuilder::forwards_to, etc. to set this value explicitly.
source§

fn metadata(&self) -> &str

Returns the arbitrary metadata string for this tunnel.

Auto Trait Implementations§

§

impl<T> Freeze for Forwarder<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Forwarder<T>
where T: RefUnwindSafe,

§

impl<T> Send for Forwarder<T>
where T: Send,

§

impl<T> Sync for Forwarder<T>
where T: Sync,

§

impl<T> Unpin for Forwarder<T>
where T: Unpin,

§

impl<T> UnwindSafe for Forwarder<T>
where T: 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
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.

§

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

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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