Struct ngrok::Builder

pub struct Builder { /* fields omitted */ }

Build a ngrok Tunnel. Use ngrok::builder() to create this.

Implementations

impl Builder

pub fn new() -> Self

Create a new Builder

pub fn http(&mut self) -> Self

Set the tunnel protocol to HTTP

pub fn port(&mut self, port: u16) -> Self

Set the tunnel port

pub fn executable(&mut self, executable: &str) -> Self

Set the ngrok executable path. By default the builder assumes ngrok is on your path.

pub fn run(self) -> Result<Tunnel, Error>

Start the ngrok child process. Note this is a blocking call and it will sleep for several seconds.

Trait Implementations

impl Clone for Builder

pub fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

pub fn default() -> Builder

Returns the "default value" for a type.