Struct poem_openapi::payload::Attachment

source · [−]

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

Expand description

A binary payload for download file.

Implementations

source

impl<T: Into<Body> + Send> Attachment<T>

source

pub fn new(data: T) -> Self

Create an attachment with data.

source

pub fn attachment_type(self, ty: AttachmentType) -> Self

Specify the attachment. (defaults to: AttachmentType::Inline)

source

pub fn filename(self, filename: impl Into<String>) -> Self

Specify the file name.

Trait Implementations

source

impl<T: Into<Body> + Send> ApiResponse for Attachment<T>

source

fn meta() -> MetaResponses

Gets metadata of this response.

source

fn register(_registry: &mut Registry)

Register the schema contained in this response object to the registry.

source

const BAD_REQUEST_HANDLER: bool = false

If true, it means that the response object has a custom bad request handler. Read more

source

fn from_parse_request_error(err: Error) -> Self

Convert poem::Error to this response object.

source

impl<T: Clone> Clone for Attachment<T>

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<T: Debug> Debug for Attachment<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T: Into<Body> + Send> IntoResponse for Attachment<T>

source

fn into_response(self) -> Response

Consume itself and return Response.

source

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

Wrap an impl IntoResponse to add a header. Read more

source

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

Wrap an impl IntoResponse to with a new content type. Read more

source

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

Wrap an impl IntoResponse to set a status code. Read more

source

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

Wrap an impl IntoResponse to set a body. Read more

source

impl<T: PartialEq> PartialEq<Attachment<T>> for Attachment<T>

source

fn eq(&self, other: &Attachment<T>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<T: Into<Body> + Send> Payload for Attachment<T>

source

const CONTENT_TYPE: &'static str = Binary<T>::CONTENT_TYPE

The content type of this payload.

source

fn schema_ref() -> MetaSchemaRef

Gets schema reference of this payload.

source

fn check_content_type(content_type: &str) -> bool

Check the content type of incoming request

source

fn register(registry: &mut Registry)

Register the schema contained in this payload to the registry.

source

impl<T: Eq> Eq for Attachment<T>

source

impl<T> StructuralEq for Attachment<T>

source

impl<T> StructuralPartialEq for Attachment<T>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

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 for Twhere
U: From<T>,

const: unstable · 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> IntoResult<T> for Twhere
T: IntoResponse,

source

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

Consumes this value returns a poem::Result<T>.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for Twhere
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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct poem_openapi::payload::Attachment

Implementations

impl<T: Into<Body> + Send> Attachment<T>

pub fn new(data: T) -> Self

pub fn attachment_type(self, ty: AttachmentType) -> Self

pub fn filename(self, filename: impl Into<String>) -> Self

Trait Implementations

impl<T: Into<Body> + Send> ApiResponse for Attachment<T>

fn meta() -> MetaResponses

fn register(_registry: &mut Registry)

const BAD_REQUEST_HANDLER: bool = false

fn from_parse_request_error(err: Error) -> Self

impl<T: Clone> Clone for Attachment<T>

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

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

impl<T: Debug> Debug for Attachment<T>

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

impl<T: Into<Body> + Send> IntoResponse for Attachment<T>

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>

impl<T: PartialEq> PartialEq<Attachment<T>> for Attachment<T>

fn eq(&self, other: &Attachment<T>) -> bool

const fn ne(&self, other: &Rhs) -> bool

impl<T: Into<Body> + Send> Payload for Attachment<T>

const CONTENT_TYPE: &'static str = Binary<T>::CONTENT_TYPE

fn schema_ref() -> MetaSchemaRef

fn check_content_type(content_type: &str) -> bool

fn register(registry: &mut Registry)

impl<T: Eq> Eq for Attachment<T>

impl<T> StructuralEq for Attachment<T>

impl<T> StructuralPartialEq for Attachment<T>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

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 Twhere U: From<T>,

fn into(self) -> U

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

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

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

impl<T, U> TryInto<U> for Twhere 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 Twhere 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>

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> RefUnwindSafe for Attachment<T>where
T: RefUnwindSafe,

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

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

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

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

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

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

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

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

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

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