Struct Responder

pub struct Responder<'p, P>
where
    P: Pack,
{ /* private fields */ }

Responder service, providing http response for requests, looking for File in Pack.

There are two main methods for this type:

• Self::respond - generates http response for successful requests and lets user handle errors manually.
• Self::respond_flatten - like above, but generates default responses also for errors.

Examples

let pack_archived = web_static_pack::loader::load(...).unwrap();
let responder = web_static_pack::responder::Responder::new(pack_archived);

assert_eq!(
    responder.respond_flatten(
        &Method::GET,
        "/present",
        &HeaderMap::default(),
    ).status(),
    StatusCode::OK
);
assert_eq!(
    responder.respond_flatten(
        &Method::GET,
        "/missing",
        &HeaderMap::default(),
    ).status(),
    StatusCode::NOT_FOUND
);

assert_eq!(
    responder.respond(
        &Method::GET,
        "/missing",
        &HeaderMap::default(),
    ),
    Err(ResponderRespondError::PackPathNotFound)
);

For full example, including making a hyper server, see crate level documentation.

Implementations

impl<'p, P> Responder<'p, P>

where P: Pack,

pub const fn new(pack: &'p P) -> Self

Creates new instance, based on Pack.

pub fn respond( &self, method: &Method, path: &str, headers: &HeaderMap, ) -> Result<Response<'p>, ResponderRespondError>

Returns http response for given request parts or rust error to be handled by user.

Inside this method:

• Checks http method (accepts GET or HEAD).
• Looks for file inside pack passed in constructor.
• Checks for ETag match (and returns 304).
• Negotiates content encoding.
• Builds final http response containing header and body (if method is not HEAD).

For alternative handling errors with default http responses see Self::respond_flatten.

pub fn respond_flatten( &self, method: &Method, path: &str, headers: &HeaderMap, ) -> Response<'p>

Like Self::respond, but generates “default” (proper http status code and empty body) responses also for errors. This will for example generate HTTP 404 response for request uri not found in path.

For manual error handling, see Self::respond.

Trait Implementations

impl<'p, P> Debug for Responder<'p, P>

where P: Pack + Debug,

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

Formats the value using the given formatter.