Struct light_pencil::Pencil

pub struct Pencil {
    pub root_path: String,
    pub name: String,
    pub static_folder: String,
    pub static_url_path: String,
    pub template_folder: String,
    pub extensions: ShareMap,
    pub url_map: Map,
    // some fields omitted
}

Fields

root_path: String

name: String

static_folder: String

static_url_path: String

template_folder: String

extensions: ShareMap

url_map: Map

Methods

impl Pencil

fn new(root_path: &str) -> Pencil

fn is_debug(&self) -> bool

fn is_testing(&self) -> bool

fn route<M: Into<Matcher>, N: AsRef<[Method]>>(
    &mut self,
    rule: M,
    methods: N,
    endpoint: &str,
    view_func: ViewFunc
)

fn get<M: Into<Matcher>>(
    &mut self,
    rule: M,
    endpoint: &str,
    view_func: ViewFunc
)

fn post<M: Into<Matcher>>(
    &mut self,
    rule: M,
    endpoint: &str,
    view_func: ViewFunc
)

fn delete<M: Into<Matcher>>(
    &mut self,
    rule: M,
    endpoint: &str,
    view_func: ViewFunc
)

fn patch<M: Into<Matcher>>(
    &mut self,
    rule: M,
    endpoint: &str,
    view_func: ViewFunc
)

fn put<M: Into<Matcher>>(
    &mut self,
    rule: M,
    endpoint: &str,
    view_func: ViewFunc
)

fn add_url_rule(
    &mut self,
    matcher: Matcher,
    methods: &[Method],
    endpoint: &str,
    view_func: ViewFunc
)

fn enable_static_file_handling(&mut self)

fn before_request<F: Fn(&mut Request) -> Option<PencilResult> + Send + Sync + 'static>(
    &mut self,
    f: F
)

fn after_request<F: Fn(&Request, &mut Response) + Send + Sync + 'static>(
    &mut self,
    f: F
)

fn teardown_request<F: Fn(Option<&PencilError>) + Send + Sync + 'static>(
    &mut self,
    f: F
)

fn register_http_error_handler<F: Fn(HTTPError) -> PencilResult + Send + Sync + 'static>(
    &mut self,
    status_code: u16,
    f: F
)

fn register_user_error_handler<F: Fn(UserError) -> PencilResult + Send + Sync + 'static>(
    &mut self,
    error_desc: &str,
    f: F
)

fn httperrorhandler<F: Fn(HTTPError) -> PencilResult + Send + Sync + 'static>(
    &mut self,
    status_code: u16,
    f: F
)

fn usererrorhandler<F: Fn(UserError) -> PencilResult + Send + Sync + 'static>(
    &mut self,
    error_desc: &str,
    f: F
)

fn handle_request(&self, request: &mut Request) -> Response

fn run<A: ToSocketAddrs>(self, addr: A)

fn run_threads<A: ToSocketAddrs>(self, addr: A, threads: usize)

Trait Implementations

impl Handler for Pencil

fn handle(&self, req: HTTPRequest, res: HTTPResponse)

Receives a Request/Response pair, and should perform some action on them.

fn check_continue(&self, (&Method, &RequestUri, &Headers)) -> StatusCode

Called when a Request includes a Expect: 100-continue header.

fn on_connection_start(&self)

This is run after a connection is received, on a per-connection basis (not a per-request basis, as a connection with keep-alive may handle multiple requests)

fn on_connection_end(&self)

This is run before a connection is closed, on a per-connection basis (not a per-request basis, as a connection with keep-alive may handle multiple requests)

impl PathBound for Pencil

fn open_resource(&self, resource: &str) -> File

impl Display for Pencil

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

Formats the value using the given formatter.

impl Debug for Pencil

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

Formats the value using the given formatter.