Struct hyper_staticfile::ResponseBuilder

pub struct ResponseBuilder<'a> {
    pub path: &'a str,
    pub query: Option<&'a str>,
    pub file_response_builder: FileResponseBuilder,
}

Utility to build the default response for a resolve result.

This struct allows direct access to its fields, but these fields are typically initialized by the accessors, using the builder pattern. The fields are basically a bunch of settings that determine the response details.

Fields

path: &'a str

The request path.

query: Option<&'a str>

The request query string.

file_response_builder: FileResponseBuilder

Inner file response builder.

Implementations

impl<'a> ResponseBuilder<'a>

pub fn new() -> Self

Create a new builder with a default configuration.

pub fn request<B>(&mut self, req: &'a Request<B>) -> &mut Self

Apply parameters based on a request.

pub fn request_parts( &mut self, method: &Method, uri: &'a Uri, headers: &'a HeaderMap ) -> &mut Self

Apply parameters based on request parts.

pub fn request_uri(&mut self, uri: &'a Uri) -> &mut Self

Apply parameters based on a request URI.

pub fn cache_headers(&mut self, value: Option<u32>) -> &mut Self

Add cache headers to responses for the given lifespan.

pub fn path(&mut self, value: &'a str) -> &mut Self

Set the request path.

pub fn query(&mut self, value: Option<&'a str>) -> &mut Self

Set the request query string.

pub fn build<F: IntoFileAccess>( &self, result: ResolveResult<F> ) -> Result<Response<Body<F::Output>>>

Build a response for the given request and resolve result.

This function may error if it response could not be constructed, but this should be a seldom occurrence.

Trait Implementations

impl<'a> Clone for ResponseBuilder<'a>

fn clone(&self) -> ResponseBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ResponseBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ResponseBuilder<'a>

fn default() -> ResponseBuilder<'a>

Returns the “default value” for a type.