Struct EventStreamRequest 

#[non_exhaustive]
pub struct EventStreamRequest {
    pub since: Option<DateTime<Utc>>,
    pub until: Option<DateTime<Utc>>,
    pub since_id: Option<String>,
    pub until_id: Option<String>,
}

Available on crate feature _sse only.

The window an event stream replays before going live.

Not interchangeable with the broker’s broker::GetEventsRequest, and the difference is not cosmetic: the five older streams bound their window by date, while every stream found in the reference sweep — admin actions, IPO events, system events, account activities, corporate actions — bounds it by timestamp. Sending a bare date to a route that parses RFC-3339 is how a filter silently stops filtering.

The cursor pair is a ULID, and since_id here means the ULID everywhere it is accepted — unlike the v1 broker streams, where that name belongs to a deprecated integer form.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

since: Option<DateTime<Utc>>

Replay events emitted at or after this time.

until: Option<DateTime<Utc>>

Close the connection after the last event at or before this time.

Alpaca requires since whenever this is set, and rejects a future value.

since_id: Option<String>

Replay events from this ULID onwards.

Whether the event with this id is itself redelivered depends on the stream, and Alpaca’s reference states it both ways: the corporate-actions stream documents it as inclusive, while the IPO-events stream says “the first event returned will be the one immediately after since_id”. One filter type serves every stream, so this cannot promise either.

Treat the first event after a resume as possibly-duplicate and deduplicate on id: that is correct under both readings, where assuming exclusivity drops an event on every reconnect if the stream turns out to be inclusive.

Mutually exclusive with since.

until_id: Option<String>

Close the connection once this ULID has been delivered, inclusive.

Implementations

impl EventStreamRequest

pub fn since(since: DateTime<Utc>) -> Self

Events from since onwards.

pub fn from_id(since_id: impl Into<String>) -> Self

Events from this ULID onwards, which is how a dropped stream is resumed.

Named from_id rather than after_id because “after” asserts an exclusivity that only some of these streams have — see EventStreamRequest::since_id, and deduplicate on id.

Trait Implementations

impl Clone for EventStreamRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventStreamRequest

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

Formats the value using the given formatter.

impl Default for EventStreamRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventStreamRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EventStreamRequest

impl PartialEq for EventStreamRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EventStreamRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EventStreamRequest