Struct Config

pub struct Config {
    pub ssl: bool,
    /* private fields */
}

Fields

ssl: bool

Implementations

impl Config

pub fn new() -> Config

Generates default settings (which don’t work by itself)

Chain with mount_point or routes

Example:

use tinyhttp::prelude::*;

#[get("/test")]
fn get_test() -> String {
  String::from("Hello, there!\n")
}

let routes = Routes::new(vec![get_test()]);
let routes_config = Config::new().routes(routes);
/// or
let mount_config = Config::new().mount_point(".");

pub fn mount_point<P: Into<String>>(self, path: P) -> Self

A mount point that will be searched when a request isn’t defined with a get or post route

Example:

let config = Config::new().mount_point(".")
/// if index.html exists in current directory, it will be returned if "/" or "/index.html" is requested.

pub fn routes(self, routes: Routes) -> Self

Add routes with a Route member

Example:

use tinyhttp::prelude::*;


#[get("/test")]
fn get_test() -> &'static str {
  "Hello, World!"
}

#[post("/test")]
fn post_test() -> Vec<u8> {
  b"Hello, Post!".to_vec()
}

fn main() {
  let socket = TcpListener::new(":::80").unwrap();
  let routes = Routes::new(vec![get_test(), post_test()]);
  let config = Config::new().routes(routes);
  let http = HttpListener::new(socket, config);

  http.start();
}

pub fn ssl(self, ssl_chain: String, ssl_priv: String) -> Self

Enables SSL

Example:

let config = Config::new().ssl("./fullchain.pem", "./privkey.pem");

This will only accept HTTPS connections

pub fn debug(self) -> Self

pub fn headers(self, headers: Vec<String>) -> Self

Define custom headers

let config = Config::new().headers(vec!["Access-Control-Allow-Origin: *".into()]);

pub fn br(self, res: bool) -> Self

DOES NOT WORK! Enables brotli compression

pub fn spa(self, res: bool) -> Self

pub fn gzip(self, res: bool) -> Self

Enables gzip compression

pub fn http2(self, res: bool) -> Self

pub fn request_middleware<F: FnMut(&mut Request) + Send + Sync + 'static>( self, middleware_fn: F, ) -> Self

pub fn response_middleware<F: FnMut(&mut Response) + Send + Sync + 'static>( self, middleware_fn: F, ) -> Self

pub fn get_headers(&self) -> Option<&HashMap<String, String>>

pub fn get_br(&self) -> bool

pub fn get_gzip(&self) -> bool

pub fn get_debug(&self) -> bool

pub fn get_mount(&self) -> Option<&String>

pub fn get_routes(&self, req_path: &str) -> Option<&dyn Route>

pub fn post_routes(&self, req_path: &str) -> Option<&dyn Route>

pub fn get_spa(&self) -> bool

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.