Struct Tunnel

Source

pub struct Tunnel { /* private fields */ }

Expand description

A quick trycloudflare.com tunnel process. Named-tunnel configuration is deliberately supplied by the CLI/setup layer; this type only owns the sidecar lifecycle and URL discovery.

Implementations§

Source §

impl Tunnel

Source

pub async fn quick(port: u16) -> Result<Self>

Start a quick tunnel to a loopback host port. URL discovery is bounded; a running process with no parsed URL is still returned so callers can report “started, URL unknown” instead of hanging forever.

Source

pub fn named(config: &Path, tunnel_id: &str) -> Result<Self>

Start a named tunnel from a generated cloudflared config.

Source

pub fn public_url(&self) -> Option<&str>

The parsed public URL, if cloudflared printed one during startup.

Source

pub async fn wait(&mut self) -> Option<bool>

Wait until the sidecar exits, returning its success status.

Source

pub async fn stop(&mut self)

Kill the sidecar and wait for it to exit.

Auto Trait Implementations§

§

impl UnsafeUnpin for Tunnel

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> Downcast for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §