Struct Server 

pub struct Server { /* private fields */ }

The editor’s HTTP server, configured for one repository.

Implementations

impl Server

pub fn new(app: impl App) -> Self

Build a server for an app.

Panics when a table takes one of the reserved names, because such a table is unreachable: the control endpoints and the stop subcommand are matched first. Panics, too, when a table’s file is not a bare name, since every file is resolved against the one Data/ directory.

Examples found in repository

examples/library/main.rs (lines 1046-1053)

fn main() -> anyhow::Result<()> {
    // The tables belong to the example, not to whoever ran it.
    std::env::set_current_dir(concat!(env!("CARGO_MANIFEST_DIR"), "/examples/library"))?;

    let command = ServerArgs::augment_help(Cli::command(), "the front page", DEFAULT_PORT);
    let cli = Cli::from_arg_matches(&command.get_matches())?;

    match cli.command {
        Command::Web(args) => Server::new(Library {
            books: Books,
            genres: Genres,
            branches: Branches,
            on_loan: OnLoan,
            branch_cards: BranchCards,
            branch_detail: BranchDetail,
        })
        .child_env("LIBRARY_EXAMPLE_CHILD")
        .default_port(DEFAULT_PORT)
        .run(args),
    }
}

pub fn index_html(self, html: &'static str) -> Self

Serve a bundle of the repository’s own in place of the embedded one.

pub fn child_env(self, var: &'static str) -> Self

The environment variable marking the detached worker process. A repository whose server is registered as a system service keeps its own name here, so the service entry does not have to change.

Examples found in repository

examples/library/main.rs (line 1054)

fn main() -> anyhow::Result<()> {
    // The tables belong to the example, not to whoever ran it.
    std::env::set_current_dir(concat!(env!("CARGO_MANIFEST_DIR"), "/examples/library"))?;

    let command = ServerArgs::augment_help(Cli::command(), "the front page", DEFAULT_PORT);
    let cli = Cli::from_arg_matches(&command.get_matches())?;

    match cli.command {
        Command::Web(args) => Server::new(Library {
            books: Books,
            genres: Genres,
            branches: Branches,
            on_loan: OnLoan,
            branch_cards: BranchCards,
            branch_detail: BranchDetail,
        })
        .child_env("LIBRARY_EXAMPLE_CHILD")
        .default_port(DEFAULT_PORT)
        .run(args),
    }
}

pub fn command(self, command: &'static str) -> Self

The subcommand that reaches Server::run, used when re-invoking the binary as a detached worker.

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

The port to bind when the command line names none. Each app on a machine takes its own, so one editor never lands on another’s port.

Examples found in repository

examples/library/main.rs (line 1055)

fn main() -> anyhow::Result<()> {
    // The tables belong to the example, not to whoever ran it.
    std::env::set_current_dir(concat!(env!("CARGO_MANIFEST_DIR"), "/examples/library"))?;

    let command = ServerArgs::augment_help(Cli::command(), "the front page", DEFAULT_PORT);
    let cli = Cli::from_arg_matches(&command.get_matches())?;

    match cli.command {
        Command::Web(args) => Server::new(Library {
            books: Books,
            genres: Genres,
            branches: Branches,
            on_loan: OnLoan,
            branch_cards: BranchCards,
            branch_detail: BranchDetail,
        })
        .child_env("LIBRARY_EXAMPLE_CHILD")
        .default_port(DEFAULT_PORT)
        .run(args),
    }
}

pub fn worker_args(self, args: impl IntoIterator<Item = String>) -> Self

Arguments to pass on to the detached worker, after the table and the port.

The worker is a fresh invocation of this binary, and it is given only the table and the port, so a flag the user passed the parent does not reach it. A repository whose subcommand takes a flag the serving process needs—one naming a companion service, say—forwards it here. The worker inherits the environment either way, so a setting that already lives in a variable needs no forwarding.

What is forwarded lands on the worker’s command line, so each argument has to be one the editor’s subcommand declares. It must be a flag and not a positional, because the table is the only positional that command line has—a forwarded positional is refused outright—and it must not repeat --port or the table, which are passed already. An argument that breaks these rules leaves the worker unable to parse its own command line, and the launch then fails with what the worker said.

pub fn before_launch(self, f: impl Fn() + Send + 'static) -> Self

Work to do once, in the process the user invoked, before a server is started or reused: bringing up a companion service, say. It does not run in the detached worker.

pub fn run(self, args: ServerArgs) -> Result<()>

Examples found in repository

examples/library/main.rs (line 1056)

fn main() -> anyhow::Result<()> {
    // The tables belong to the example, not to whoever ran it.
    std::env::set_current_dir(concat!(env!("CARGO_MANIFEST_DIR"), "/examples/library"))?;

    let command = ServerArgs::augment_help(Cli::command(), "the front page", DEFAULT_PORT);
    let cli = Cli::from_arg_matches(&command.get_matches())?;

    match cli.command {
        Command::Web(args) => Server::new(Library {
            books: Books,
            genres: Genres,
            branches: Branches,
            on_loan: OnLoan,
            branch_cards: BranchCards,
            branch_detail: BranchDetail,
        })
        .child_env("LIBRARY_EXAMPLE_CHILD")
        .default_port(DEFAULT_PORT)
        .run(args),
    }
}