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
sourceimpl<T> EventStream<T>
impl<T> EventStream<T>
sourcepub fn keep_alive(self, duration: Duration) -> Self
pub fn keep_alive(self, duration: Duration) -> Self
Set the keep alive interval.
Trait Implementations
sourceimpl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> ApiResponse for EventStream<T>
impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> ApiResponse for EventStream<T>
sourcefn register(registry: &mut Registry)
fn register(registry: &mut Registry)
Register the schema contained in this response object to the registry.
sourceconst BAD_REQUEST_HANDLER: bool = false
const BAD_REQUEST_HANDLER: bool = false
If true, it means that the response object has a custom bad request handler. Read more
sourcefn from_parse_request_error(err: Error) -> Self
fn from_parse_request_error(err: Error) -> Self
Convert poem::Error to this response object.
sourceimpl<T: Clone> Clone for EventStream<T>
impl<T: Clone> Clone for EventStream<T>
sourcefn clone(&self) -> EventStream<T>
fn clone(&self) -> EventStream<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl<T: Debug> Debug for EventStream<T>
impl<T: Debug> Debug for EventStream<T>
sourceimpl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> IntoResponse for EventStream<T>
impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> IntoResponse for EventStream<T>
sourcefn into_response(self) -> Response
fn into_response(self) -> Response
Consume itself and return Response.
sourcefn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self> where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
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
sourcefn with_content_type<V>(self, content_type: V) -> WithContentType<Self> where
V: TryInto<HeaderValue>,
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
sourcefn with_status(self, status: StatusCode) -> WithStatus<Self>
fn with_status(self, status: StatusCode) -> WithStatus<Self>
Wrap an impl IntoResponse to set a status code. Read more
sourceimpl<T: PartialEq> PartialEq<EventStream<T>> for EventStream<T>
impl<T: PartialEq> PartialEq<EventStream<T>> for EventStream<T>
sourcefn eq(&self, other: &EventStream<T>) -> bool
fn eq(&self, other: &EventStream<T>) -> bool
This method tests for self and other values to be equal, and is used
by ==. Read more
sourcefn ne(&self, other: &EventStream<T>) -> bool
fn ne(&self, other: &EventStream<T>) -> bool
This method tests for !=.
sourceimpl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> Payload for EventStream<T>
impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> Payload for EventStream<T>
sourceconst CONTENT_TYPE: &'static str = "text/event-stream"
const CONTENT_TYPE: &'static str = "text/event-stream"
The content type of this payload.
sourcefn schema_ref() -> MetaSchemaRef
fn schema_ref() -> MetaSchemaRef
Gets schema reference of this payload.
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key and return true if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> IntoResult<T> for T where
T: IntoResponse,
impl<T> IntoResult<T> for T where
T: IntoResponse,
sourcefn into_result(self) -> Result<T, Error>
fn into_result(self) -> Result<T, Error>
Consumes this value returns a poem::Result<T>.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more