Struct gotham_restful::Success

pub struct Success<T> { /* private fields */ }

This can be returned from a resource when there is no cause of an error.

Usage example:

#[derive(Deserialize, Serialize)]
struct MyResponse {
	message: &'static str
}

#[read_all]
fn read_all() -> Success<MyResponse> {
	let res = MyResponse {
		message: "I'm always happy"
	};
	res.into()
}

Implementations

impl<T> Success<T>

pub fn header<K: IntoHeaderName>(&mut self, name: K, value: HeaderValue)

Set a custom HTTP header. If a header with this name was set before, its value is being updated.

pub fn headers_mut(&mut self) -> &mut HeaderMap

Allow manipulating HTTP headers.

Trait Implementations

impl<T: Clone> Clone for Success<T>

fn clone(&self) -> Success<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Success<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Success<T>

fn default() -> Success<T>

Returns the “default value” for a type.

impl<T> From<T> for Success<T>

fn from(t: T) -> Self

Converts to this type from the input type.

impl<T: ResponseBody> IntoResponse for Success<T>

type Err = Error

fn into_response( self ) -> Pin<Box<dyn Future<Output = Result<Response, Self::Err>> + Send>>

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

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

Return a list of supported mime types.

impl<T: ResponseBody> ResponseSchema for Success<T>

fn schema(code: StatusCode) -> OpenapiSchema

Return the schema of the response for the given status code. The code may only be one that was previously returned by Self::status_codes. The implementation should panic if that is not the case.

fn status_codes() -> Vec<StatusCode>

All status codes returned by this response. Returns [StatusCode::OK] by default.