[−][src]Struct sharp_pencil::Module
Represents a module.
Fields
name: String
The name of the module.
root_path: String
The path where your module locates.
static_folder: Option<String>
The folder with static files that should be served at static_url_path
.
static_url_path: Option<String>
The url path for the static files on the web.
template_folder: Option<String>
The folder that contains the templates that should be used for the module.
Implementations
impl Module
[src]
pub fn new(name: &str, root_path: &str) -> Module
[src]
pub fn route<M: Into<Matcher>, N: AsRef<[Method]>>(
&mut self,
rule: M,
methods: N,
endpoint: &str,
view_func: ViewFunc
)
[src]
&mut self,
rule: M,
methods: N,
endpoint: &str,
view_func: ViewFunc
)
The endpoint is automatically prefixed with the module's name.
pub fn before_request<F: Fn(&mut Request<'_, '_, '_>) -> Option<PencilResult> + Send + Sync + 'static>(
&mut self,
f: F
)
[src]
&mut self,
f: F
)
Before request for a module. This is only executed before each request that is handled by a view function of that module.
pub fn before_app_request<F: Fn(&mut Request<'_, '_, '_>) -> Option<PencilResult> + Send + Sync + Clone + 'static>(
&mut self,
f: F
)
[src]
&mut self,
f: F
)
Before request for the app that this module is registered on. This is executed before each request, even if outside of a module.
pub fn after_request<F: Fn(&Request<'_, '_, '_>, &mut Response) + Send + Sync + 'static>(
&mut self,
f: F
)
[src]
&mut self,
f: F
)
After request for a module. This is only executed after each request that is handled by a view function of that module.
pub fn after_app_request<F: Fn(&Request<'_, '_, '_>, &mut Response) + Send + Sync + Clone + 'static>(
&mut self,
f: F
)
[src]
&mut self,
f: F
)
After request for the app that this module is registered on. This is executed after each request, even if outside of a module.
pub fn teardown_request<F: Fn(Option<&PencilError>) + Send + Sync + 'static>(
&mut self,
f: F
)
[src]
&mut self,
f: F
)
Teardown request for a module. This is only executed when tearing down each request that is handled by a view function of that module.
pub fn teardown_app_request<F: Fn(Option<&PencilError>) + Send + Sync + Clone + 'static>(
&mut self,
f: F
)
[src]
&mut self,
f: F
)
Teardown request for the app that this module is registered on. This is executed when tearing down each request, even if outside of a module.
pub fn httperrorhandler<F: Fn(HTTPError) -> PencilResult + Send + Sync + 'static>(
&mut self,
status_code: u16,
f: F
)
[src]
&mut self,
status_code: u16,
f: F
)
Registers a http error handler that becomes active for this module only.
pub fn usererrorhandler<F: Fn(UserError) -> PencilResult + Send + Sync + 'static>(
&mut self,
error_desc: &str,
f: F
)
[src]
&mut self,
error_desc: &str,
f: F
)
Registers an user error handler that becomes active for this module only.
pub fn app_httperrorhandler<F: Fn(HTTPError) -> PencilResult + Send + Sync + Clone + 'static>(
&mut self,
status_code: u16,
f: F
)
[src]
&mut self,
status_code: u16,
f: F
)
Registers a http error handler for all requests of the application.
pub fn app_usererrorhandler<F: Fn(UserError) -> PencilResult + Send + Sync + Clone + 'static>(
&mut self,
error_desc: &str,
f: F
)
[src]
&mut self,
error_desc: &str,
f: F
)
Registers an user error handler for all requests of the application.
pub fn register(self, app: &mut Pencil)
[src]
Register this module.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Module
impl Send for Module
impl Sync for Module
impl Unpin for Module
impl !UnwindSafe for Module
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DebugAny for T where
T: Any + Debug,
[src]
T: Any + Debug,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Typeable for T where
T: Any,
T: Any,
impl<T> UnsafeAny for T where
T: Any,
T: Any,