Struct DevServer

#[non_exhaustive]
pub struct DevServer {
    pub ip: IpAddr,
    pub port: u16,
    pub watch: Watch,
    pub command: Option<Command>,
    pub not_found_path: Option<PathBuf>,
    /* private fields */
}

A simple HTTP server useful during development.

It can watch the source code for changes and restart a provided command.

Get the files at watch_path and serve them at a given IP address (127.0.0.1:8000 by default). An optional command can be provided to restart the build when changes are detected.

Usage

use std::process;
use xtask_wasm::{
    anyhow::Result,
    clap,
    default_dist_dir,
};

#[derive(clap::Parser)]
enum Opt {
    Start(xtask_wasm::DevServer),
    Dist,
}

fn main() -> Result<()> {
    let opt: Opt = clap::Parser::parse();

    match opt {
        Opt::Start(mut dev_server) => {
            log::info!("Starting the development server...");
            dev_server.arg("dist").start(default_dist_dir(false))?;
        }
        Opt::Dist => todo!("build project"),
    }

    Ok(())
}

Add a start subcommand that will run cargo xtask dist, watching for changes in the workspace and serve the files in the default dist directory (target/debug/dist for non-release) at a given IP address.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ip: IpAddr

IP address to bind. Default to 127.0.0.1.

port: u16

Port number. Default to 8000.

watch: Watch

Watch object for detecting changes.

Note

Used only if command is set.

command: Option<Command>

Command executed when a change is detected.

not_found_path: Option<PathBuf>

Use another file path when the URL is not found.

Implementations

impl DevServer

pub fn address(self, ip: IpAddr, port: u16) -> Self

Set the dev-server binding address.

pub fn command(self, command: Command) -> Self

Set the command that is executed when a change is detected.

pub fn arg<S: AsRef<OsStr>>(self, arg: S) -> Self

Adds an argument to pass to the command executed when changes are detected.

This will use the xtask command by default.

pub fn args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Adds multiple arguments to pass to the command executed when changes are detected.

This will use the xtask command by default.

pub fn not_found(self, path: impl Into<PathBuf>) -> Self

Use another file path when the URL is not found.

pub fn request_handler<F>(self, handler: F) -> Self

where F: Fn(Request<'_>) -> Result<()> + Send + Sync + 'static,

Pass a custom request handler to the dev server.

pub fn start(self, dist_dir_path: impl Into<PathBuf>) -> Result<()>

Start the server, serving the files at dist_dir_path.

crate::default_dist_dir should be used to get the dist directory that needs to be served.

Trait Implementations

impl Args for DevServer

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for DevServer

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for DevServer

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

Formats the value using the given formatter.

impl Default for DevServer

fn default() -> DevServer

Returns the “default value” for a type.

impl FromArgMatches for DevServer

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for DevServer

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.