Enum poem_openapi::response::StaticFileResponse

source · [−]

pub enum StaticFileResponse {
    Ok(Binary<Body>, Option<String>, Option<String>, Option<String>),
    NotModified,
    BadRequest,
    NotFound,
    PreconditionFailed,
    RangeNotSatisfiable(String),
    InternalServerError(PlainText<String>),
}

Available on crate feature static-files only.

Expand description

A static file response.

Variants

`Ok(Binary<Body>, Option<String>, Option<String>, Option<String>)`

Tuple Fields

0: Binary<Body>

1: Option<String>

The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed. Additionally, etags help to prevent simultaneous updates of a resource from overwriting each other (“mid-air collisions”).

Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

2: Option<String>

The Last-Modified response HTTP header contains a date and time when the origin server believes the resource was last modified. It is used as a validator to determine if the resource is the same as the previously stored one. Less accurate than an ETag header, it is a fallback mechanism. Conditional requests containing If-Modified-Since or If-Unmodified-Since headers make use of this field.

Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified

3: Option<String>

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type

Ok

`NotModified`

Not modified

Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304

`BadRequest`

Bad request

Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400

`NotFound`

Resource was not found

`PreconditionFailed`

Precondition failed

Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412

`RangeNotSatisfiable(String)`

Tuple Fields

0: String

The Content-Range response HTTP header indicates where in a full body message a partial message belongs.

Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range

Range not satisfiable

Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416

`InternalServerError(PlainText<String>)`

Internal server error

Enum poem_openapi::response::StaticFileResponse

Variants

Ok(Binary<Body>, Option<String>, Option<String>, Option<String>)

Tuple Fields

NotModified

BadRequest

NotFound

PreconditionFailed

RangeNotSatisfiable(String)

Tuple Fields

InternalServerError(PlainText<String>)

Implementations

impl StaticFileResponse

pub fn new(res: Result<StaticFileResponse, StaticFileError>) -> Self

Trait Implementations

impl ApiResponse for StaticFileResponse

const BAD_REQUEST_HANDLER: bool = false

fn meta() -> MetaResponses

fn register(registry: &mut Registry)

fn from_parse_request_error(err: Error) -> Self

impl From<Result<StaticFileResponse, StaticFileError>> for StaticFileResponse

fn from(res: Result<StaticFileResponse, StaticFileError>) -> Self

impl From<StaticFileResponse> for Error

fn from(resp: StaticFileResponse) -> Error

impl IntoResponse for StaticFileResponse

fn into_response(self) -> Response

fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self> where K: TryInto<HeaderName>, V: TryInto<HeaderValue>,

fn with_content_type<V>(self, content_type: V) -> WithContentType<Self> where V: TryInto<HeaderValue>,

fn with_status(self, status: StatusCode) -> WithStatus<Self>

fn with_body(self, body: impl Into<Body>) -> WithBody<Self>

Auto Trait Implementations

impl !RefUnwindSafe for StaticFileResponse

impl Send for StaticFileResponse

impl Sync for StaticFileResponse

impl Unpin for StaticFileResponse

impl !UnwindSafe for StaticFileResponse

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

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>,

fn into(self) -> U

impl<T> IntoResult<T> for T where T: IntoResponse,

fn into_result(self) -> Result<T, Error>

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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>

`Ok(Binary<Body>, Option<String>, Option<String>, Option<String>)`

`NotModified`

`BadRequest`

`NotFound`

`PreconditionFailed`

`RangeNotSatisfiable(String)`

`InternalServerError(PlainText<String>)`

fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self> where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,

fn with_content_type<V>(self, content_type: V) -> WithContentType<Self> where
V: TryInto<HeaderValue>,

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> IntoResult<T> for T where
T: IntoResponse,

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>,