Struct gotham_restful::Raw

source · 
pub struct Raw<T> {
    pub raw: T,
    pub mime: Mime,
}
Expand description

This type can be used both as a raw request body, as well as as a raw response. However, all types of request bodies are accepted by this type. It is therefore recommended to derive your own type from RequestBody and only use this when you need to return a raw response. This is a usage example that simply returns its body:

#[derive(Resource)]
#[resource(create)]
struct ImageResource;

#[create]
fn create(body: Raw<Vec<u8>>) -> Raw<Vec<u8>> {
	body
}

Fields§

§raw: T§mime: Mime

Implementations§

source§

impl<T> Raw<T>

source

pub fn new(raw: T, mime: Mime) -> Self

Trait Implementations§

source§

impl<T, U> AsMut<U> for Raw<T>
where T: AsMut<U>,

source§

fn as_mut(&mut self) -> &mut U

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl<T, U> AsRef<U> for Raw<T>
where T: AsRef<U>,

source§

fn as_ref(&self) -> &U

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl<T: Clone> Clone for Raw<T>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug> Debug for Raw<T>

source§

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

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

impl<T: for<'a> From<&'a [u8]>> FromBody for Raw<T>

§

type Err = Infallible

The error type returned by the conversion if it was unsuccessfull. When using the derive macro, there is no way to trigger an error, so std::convert::Infallible is used here. However, this might change in the future.
source§

fn from_body(body: Bytes, mime: Mime) -> Result<Self, Self::Err>

Perform the conversion.
source§

impl<T: Into<Body>> IntoResponse for Raw<T>
where Self: Send,

§

type Err = Error

source§

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

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.
source§

impl<T> OpenapiType for Raw<T>

source§

fn visit_type<V: Visitor>(visitor: &mut V)

§

fn schema() -> OpenapiSchema

source§

impl<T> RequestBody for Raw<T>
where Raw<T>: FromBody + ResourceType,

source§

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

Return all types that are supported as content types. Use None if all types are supported.
source§

impl<T: Into<Body>> ResponseSchema for Raw<T>
where Self: Send,

source§

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.
source§

fn status_codes() -> Vec<StatusCode>

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

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Raw<T>
where T: RefUnwindSafe,

§

impl<T> Send for Raw<T>
where T: Send,

§

impl<T> Sync for Raw<T>
where T: Sync,

§

impl<T> Unpin for Raw<T>
where T: Unpin,

§

impl<T> UnwindSafe for Raw<T>
where T: UnwindSafe,

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
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
source§

impl<R> IntoResponseWithSchema for R
where R: IntoResponse + ResponseSchema,