Struct ngrok_api::types::Tunnel

source · [−]

pub struct Tunnel {
    pub id: String,
    pub public_url: String,
    pub started_at: String,
    pub metadata: String,
    pub proto: String,
    pub region: String,
    pub tunnel_session: Ref,
    pub endpoint: Option<Ref>,
    pub labels: HashMap<String, String>,
    pub backends: Option<Vec<Ref>>,
    pub forwards_to: String,
}

Fields

id: String

unique tunnel resource identifier

public_url: String

URL of the ephemeral tunnel’s public endpoint

started_at: String

timestamp when the tunnel was initiated in RFC 3339 format

metadata: String

user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel metadata configuration option In API version 0, this value was instead pulled from the top-level metadata configuration option.

proto: String

tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls

region: String

identifier of tune region where the tunnel is running

tunnel_session: Ref

reference object pointing to the tunnel session on which this tunnel was started

endpoint: Option<Ref>

the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel

labels: HashMap<String, String>

the labels the tunnel group backends will match against, if this is a backend tunnel

backends: Option<Vec<Ref>>

tunnel group backends served by this backend tunnel

forwards_to: String

upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.

Trait Implementations

impl Clone for Tunnel

fn clone(&self) -> Tunnel

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Tunnel

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

Formats the value using the given formatter. Read more

impl Default for Tunnel

fn default() -> Tunnel

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

impl<'de> Deserialize<'de> for Tunnel

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Tunnel

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for Tunnel

impl Send for Tunnel

impl Sync for Tunnel

impl Unpin for Tunnel

impl UnwindSafe for Tunnel

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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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<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> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,