pub struct Response { /* private fields */ }
Expand description

A response, used to create the final gotham response from.

This type is not meant to be used as the return type of endpoint handlers. While it can be freely used without the openapi feature, it is more complicated to use when you enable it, since this type does not store any schema information. You can attach schema information like so:

fn schema(code: StatusCode) -> OpenapiSchema {
	assert_eq!(code, StatusCode::ACCEPTED);
	<()>::schema()
}

fn status_codes() -> Vec<StatusCode> {
	vec![StatusCode::ACCEPTED]
}

#[create(schema = "schema", status_codes = "status_codes")]
fn create(body: Raw<Vec<u8>>) {}

Implementations§

source§

impl Response

source

pub fn new<B: Into<Body>>( status: StatusCode, body: B, mime: Option<Mime> ) -> Self

Create a new Response from raw data.

source

pub fn json<B: Into<Body>>(status: StatusCode, body: B) -> Self

Create a Response with mime type json from already serialized data.

source

pub fn no_content() -> Self

Create a 204 No Content Response.

source

pub fn forbidden() -> Self

Create an empty 403 Forbidden Response.

source

pub fn status(&self) -> StatusCode

Return the status code of this Response.

source

pub fn mime(&self) -> Option<&Mime>

Return the mime type of this Response.

source

pub fn header(&mut self, name: HeaderName, value: HeaderValue)

Add an HTTP header to the Response.

Trait Implementations§

source§

impl Debug for Response

source§

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

Formats the value using the given formatter. Read more
source§

impl IntoResponse for Response

§

type Err = Infallible

source§

fn into_response(self) -> BoxFuture<'static, Result<Response, Self::Err>>

Turn this into a response that can be returned to the browser. This api will likely change in the future.
source§

fn accepted_types() -> Option<Vec<Mime>>

Return a list of supported mime types.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoSql for T

§

fn into_sql<T>(self) -> Self::Expression
where Self: AsExpression<T> + Sized, T: SqlType + TypedExpressionType,

Convert self to an expression for Diesel’s query builder. Read more
§

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression
where &'a Self: AsExpression<T>, T: SqlType + TypedExpressionType,

Convert &self to an expression for Diesel’s query builder. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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