Struct poem_openapi::payload::EventStream

source · [−]

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

Expand description

An event stream payload.

Reference: https://github.com/OAI/OpenAPI-Specification/issues/396#issuecomment-894718960

Implementations

source

impl<T> EventStream<T>

source

pub fn new(stream: T) -> Self

Create an event stream payload.

source

pub fn keep_alive(self, duration: Duration) -> Self

Set the keep alive interval.

Trait Implementations

source

impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> ApiResponse for EventStream<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

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 EventStream<T>

source

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

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 EventStream<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> IntoResponse for EventStream<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_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<EventStream<T>> for EventStream<T>

source

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

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

source

fn ne(&self, other: &EventStream<T>) -> bool

This method tests for !=.

source

impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> Payload for EventStream<T>

source

const CONTENT_TYPE: &'static str

The content type of this payload.

source

fn schema_ref() -> MetaSchemaRef

Gets schema reference of this payload.

source

fn register(registry: &mut Registry)

Register the schema contained in this payload to the registry.

source

impl<T: Eq> Eq for EventStream<T>

source

impl<T> StructuralEq for EventStream<T>

source

impl<T> StructuralPartialEq for EventStream<T>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

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

source

pub 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

pub fn from(t: T) -> T

Performs the conversion.

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

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

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

pub 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::EventStream

Implementations

impl<T> EventStream<T>

pub fn new(stream: T) -> Self

pub fn keep_alive(self, duration: Duration) -> Self

Trait Implementations

impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> ApiResponse for EventStream<T>

fn meta() -> MetaResponses

fn register(registry: &mut Registry)

const BAD_REQUEST_HANDLER: bool

fn from_parse_request_error(err: Error) -> Self

impl<T: Clone> Clone for EventStream<T>

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

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

impl<T: Debug> Debug for EventStream<T>

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

impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> IntoResponse for EventStream<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_status(self, status: StatusCode) -> WithStatus<Self>

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

impl<T: PartialEq> PartialEq<EventStream<T>> for EventStream<T>

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

fn ne(&self, other: &EventStream<T>) -> bool

impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> Payload for EventStream<T>

const CONTENT_TYPE: &'static str

fn schema_ref() -> MetaSchemaRef

fn register(registry: &mut Registry)

impl<T: Eq> Eq for EventStream<T>

impl<T> StructuralEq for EventStream<T>

impl<T> StructuralPartialEq for EventStream<T>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for T

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

pub fn into(self) -> U

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

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

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

pub 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

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

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

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

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

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

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

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

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

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<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

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

impl<T> ToOwned for T where
T: Clone,

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