Struct LiveServer 

pub struct LiveServer { /* private fields */ }

serve a raw::Config, fresh from the disk

this will almost always live behind an Arc, so expect to be .clone()ing a lot!

this autorefreshes by default. that works by hosting a new url somewhere under /.breb-sys/ (it’s long and random to avoid collisions) with a version number derived from scanning and hashing the metadata of the input directory. a bit of javascript injected into any html page to ping that, check if the value changes, and refresh.

Implementations

impl LiveServer

pub fn live_config(cfg: impl Into<PathBuf>, dir: impl Into<PathBuf>) -> Self

serve a blog in the given directory with the given config

Examples found in repository

examples/simple/main.rs (line 17)

fn main() {
	let port = env::args().nth(1)
		.map(|s| s.parse::<u16>())
		.transpose()
		.expect("that port wasn't an integer");

	let Ok(manifest_dir) = env::var("CARGO_MANIFEST_DIR") else {
		panic!("you need to run this as an example with cargo.");
	};
	let manifest_dir = Path::new(&manifest_dir);
	let example_dir = manifest_dir.join("examples/simple/");

	let in_bg = LiveServer::live_config(example_dir.join("breb.yml"), example_dir)
		.listen_background(port)
		.expect("failed to start server");
	println!("server is listening on http://{}", in_bg.address);
	// wait for ctrl+c
	loop {
		thread::sleep(Duration::MAX);
	}
}

pub fn static_config(cfg: Config, dir: impl Into<PathBuf>) -> Self

serve a blog in the given directory with a static config

pub fn without_refresh(self) -> Self

disable autorefresh

pub fn listen(&self, port: impl Into<Option<u16>>) -> Result<()>

serve forever on the current thread

pub fn listen_background( &self, port: impl Into<Option<u16>>, ) -> Result<BackgroundServer>

serve until stopped on a background thread

Examples found in repository

examples/simple/main.rs (line 18)

fn main() {
	let port = env::args().nth(1)
		.map(|s| s.parse::<u16>())
		.transpose()
		.expect("that port wasn't an integer");

	let Ok(manifest_dir) = env::var("CARGO_MANIFEST_DIR") else {
		panic!("you need to run this as an example with cargo.");
	};
	let manifest_dir = Path::new(&manifest_dir);
	let example_dir = manifest_dir.join("examples/simple/");

	let in_bg = LiveServer::live_config(example_dir.join("breb.yml"), example_dir)
		.listen_background(port)
		.expect("failed to start server");
	println!("server is listening on http://{}", in_bg.address);
	// wait for ctrl+c
	loop {
		thread::sleep(Duration::MAX);
	}
}