Examples#

Async Stateful Module#

cargo run --example async_stateful_module --features response-macros

Demonstrates use of the AsyncModule trait by implementing the module Clicker which tracks the global number of visits to the capsule.

This can easily be adapted to contain a hashmap of routes which are individually tracked for clicks.

Async#

cargo run --example async --features response-macros

Demonstrates use of async routes through an async response macro and implementing a click tracker using a shared variable through an thread-safe, async mutex.

Binary#

cargo run --example binary --features response-macros

Demonstrates the binary response functionality by using both manual and automatic mime resolution (--features auto-deduce-mime).

Callbacks#

cargo run --example callbacks

Demonstrates use of the pre and post-route callback handlers.

Certificate#

cargo run --example certificate --features response-macros

Demonstrate the various certificate related responses as well as reading the client certificate to give conditional access.

Default Logger#

cargo run --example default_logger --features logger,response-macros

A simple example showing the use of the default default logger implementation.

Empty#

cargo run --example empty

An empty example which starts up a server but has no mounted routes.

Error Handler#

cargo run --example error_handler

Creates an intentional error within a route, invoking the error handler.

Fix Path#

cargo run --example fix_path --features response-macros

A simple example which demonstrates use of the path fixer that attempts to resolve the closest match of a route when an invalid route is visited.

This feature is limited to simple resolution patches such as resolving trailing and missing trailing slashes. If your capsule requires a more sophisticated path fixer, please use any of the provided mechanisms to do so before your routes execute.

Input#

cargo run --example input

Demonstrates how to accept and inspect both standard and sensitive input.

MIME#

cargo run --example mime

Demonstrate how to modify the MIME of a response before use.

Parameters#

cargo run --example parameters --features response-macros

Demonstrate the use of route parameters (not URL queries).

Partial#

cargo run --example partial

Demonstrates use of appending headers and footers to routes, globally.

If you would like to conditionally append headers and footers based on route, please look into using a templating framework.

Query#

cargo run --example input --features response-macros

Demonstrates the inspection of URL queries parameters.

Responses#

cargo run --example responses --features response-macros

Demonstrates the use of a wide variety of responses, additionally exposing the flexibility of response bodies types.

Simple async-std#

cargo run --example simple_async_std --features async-std

Demonstrates how to explicitly specify Windmark to use the async-std runtime.

If the async-std feature is NOT enabled, Windmark will default to using Tokio as the async runtime.

Simple Tokio#

cargo run --example simple_async_std --features async-std

Demonstrates how to explicitly specify Windmark to use the Tokio runtime.

Stateful Module#

cargo run --example stateful_module --features response-macros

Demonstrates use of Modules by implementing a click tracker

Identical in functionality to the Async Stateful Module example, just not asynchronous.

Stateless Module#

cargo run --example stateless_module

Demonstrates use of a stateless module.

Unlike a Module, a stateless module is not encapsulated into a struct, but is a simple function which is used to perform operations.

Stateless modules are able to emulate stateful modules employing static variables. The earliest Windmark modules (add-ons) were made this way.

The only requirement of a module is to implement the signature of a stateless module: FnMut(&mut Router) -> ().