Struct poem_openapi::payload::EventStream

source · [−]

pub struct EventStream<T: Stream + Send + 'static> { /* private fields */ }

Expand description

An event stream payload.

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

Implementations

impl<T: Stream + Send + 'static> EventStream<T>

pub fn new(stream: T) -> Self

Create an event stream payload.

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

Set the keep alive interval.

pub fn to_event(self, f: impl FnMut(T::Item) -> Event + Send + 'static) -> Self

Set a function used to convert the message to SSE event.

Examples

use poem::web::sse::Event;
use poem_openapi::{payload::EventStream, types::ToJSON, Object};

#[derive(Debug, Object)]
struct MyEvent {
    value: i32,
}

EventStream::new(futures_util::stream::iter(vec![
    MyEvent { value: 1 },
    MyEvent { value: 2 },
    MyEvent { value: 3 },
]))
.to_event(|event| {
    let json = event.to_json_string();
    Event::message(json).event_type("push")
});

Trait Implementations

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

fn meta() -> MetaResponses

Gets metadata of this response.

fn register(registry: &mut Registry)

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

const BAD_REQUEST_HANDLER: bool = false

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

fn from_parse_request_error(err: Error) -> Self

Convert poem::Error to this response object.

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

fn into_response(self) -> Response

Consume itself and return Response.

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

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

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

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

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

Wrap an impl IntoResponse to set a body. Read more

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

const CONTENT_TYPE: &'static str = "text/event-stream"

The content type of this payload.

fn schema_ref() -> MetaSchemaRef

Gets schema reference of this payload.

fn register(registry: &mut Registry)

Register the schema contained in this payload to the registry.

Auto Trait Implementations

impl<T> !RefUnwindSafe for EventStream<T>

impl<T> Send for EventStream<T>

impl<T> !Sync for EventStream<T>

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

impl<T> !UnwindSafe for EventStream<T>

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · 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

impl<T, U> Into<U> 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.

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

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

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

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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