Struct hyper_staticfile::ResponseBuilder[−][src]

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

Expand description

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

[src]

impl<'a> ResponseBuilder<'a>

[src]

pub fn new() -> Self

Create a new builder with a default configuration.

[src]

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

Apply parameters based on a request.

[src]

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

Apply parameters based on request parts.

[src]

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

Apply parameters based on a request URI.

[src]

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

Add cache headers to responses for the given lifespan.

[src]

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

Set the request path.

[src]

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

Set the request query string.

[src]

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

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

[src]

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

[src]

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

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

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

[src]

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

Formats the value using the given formatter. Read more

[src]

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

[src]

fn default() -> ResponseBuilder<'a>

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl<'a> RefUnwindSafe for ResponseBuilder<'a>

impl<'a> Send for ResponseBuilder<'a>

impl<'a> Sync for ResponseBuilder<'a>

impl<'a> Unpin for ResponseBuilder<'a>

impl<'a> UnwindSafe for ResponseBuilder<'a>

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct hyper_staticfile::ResponseBuilder[−][src]

Fields

Implementations

impl<'a> ResponseBuilder<'a>

pub fn new() -> Self

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

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

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

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

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

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

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

Trait Implementations

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

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

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

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

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

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

fn default() -> ResponseBuilder<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for ResponseBuilder<'a>

impl<'a> Send for ResponseBuilder<'a>

impl<'a> Sync for ResponseBuilder<'a>

impl<'a> Unpin for ResponseBuilder<'a>

impl<'a> UnwindSafe for ResponseBuilder<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,