Struct aurelius::Server

pub struct Server { /* fields omitted */ }

An instance of the a markdown preview server.

The server will listen for HTTP and WebSocket connections on arbitrary ports.

Examples

use aurelius::Server;

let listening = Server::new()
    .initial_markdown("<h1>Hello, world</h1>")
    .start()
    .unwrap();

Methods

impl Server

fn new() -> Self

Create a new markdown preview server.

fn initial_markdown<S: Into<String>>(&mut self, markdown: S) -> &Self

Set the initial markdown to render when starting the server.

fn working_directory<D: Into<PathBuf>>(&mut self, directory: D) -> &Self

Set the directory that static files should be served out of.

Defaults to the process' current working directory.

fn highlight_theme<T: Into<String>>(&mut self, theme: T) -> &Self

Set the syntax highlighting theme to use.

Defaults to the "github" theme.

fn css<C: Into<String>>(&mut self, css: C) -> &Self

Set the CSS that should be used to style the markdown.

Defaults to github's CSS styles.

fn websocket_port(&mut self, port: u16) -> &Self

Set the port to listen for websocket connections on.

Defaults to an arbitrary port assigned by the OS.

fn http_port(&mut self, port: u16) -> &Self

Set the port to listen for HTTP connections on.

Defaults to an arbitrary port assigned by the OS.

fn external_renderer<C: Into<String>>(&mut self, command: C) -> &Self

Set an external command to use instead of the in-memory markdown renderer.

The command should read markdown from stdin, and output markdown on stdout.

fn start(&self) -> Result<Listening>

Starts the server.

Returns a channel that can be used to send markdown to the server. The markdown will be sent as HTML to all clients of the websocket server.

Trait Implementations

impl Debug for Server

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Server

fn clone(&self) -> Server

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Server

fn default() -> Self

Returns the "default value" for a type.