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::{Config, Server};

let listening = Server::new_with_config(
    Config {
        initial_markdown: Some(String::from("# Hello, world!")),
        ..Default::default()
    })
    .start()
    .unwrap();

Methods

impl Server

pub fn new() -> Self

Create a new markdown preview server.

pub fn new_with_config(config: Config) -> Self

Create a new markdown preview server with the given configuration.

pub 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 Default for Server

fn default() -> Self

Returns the "default value" for a type.

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 Debug for Server

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

Formats the value using the given formatter.