Struct WebService 

pub struct WebService { /* private fields */ }

Manageable web service with start/stop lifecycle

Use this when you need to programmatically control the server lifecycle, such as in tests or embedded scenarios.

Implementations

impl WebService

pub fn new(bamboo_home_dir: PathBuf) -> Self

Create a new WebService instance

Arguments

• bamboo_home_dir - Bamboo home directory (e.g., ${HOME}/.bamboo or custom path)

pub async fn start(&mut self, port: u16) -> Result<(), String>

Start the web service on the specified port using the default localhost bind.

pub async fn start_with_bind( &mut self, port: u16, bind: &str, ) -> Result<(), String>

Start the web service on the specified port and bind address.

pub async fn start_with_bind_tls( &mut self, port: u16, bind: &str, tls: Option<&TlsConfig>, ) -> Result<(), String>

Start the web service, terminating TLS itself when tls is Some (#181).

None keeps the plaintext .bind() path unchanged (desktop loopback).

pub async fn start_with_bind_and_static( &mut self, port: u16, bind: &str, static_dir: PathBuf, ) -> Result<(), String>

Start the web service on the specified port and bind address, serving static files alongside the API routes.

pub async fn start_with_bind_and_static_tls( &mut self, port: u16, bind: &str, static_dir: PathBuf, tls: Option<&TlsConfig>, ) -> Result<(), String>

Like WebService::start_with_bind_and_static, terminating TLS itself when tls is Some (#181). None keeps the plaintext path unchanged.

pub async fn stop(&mut self) -> Result<(), String>

Stop the web service

pub fn is_running(&self) -> bool

Check if the web service is currently running

pub fn port(&self) -> u16

Get the port the web service is running on

Trait Implementations

impl Drop for WebService

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.