Struct SubscribeRequest 

pub struct SubscribeRequest {
    pub channel: String,
    pub symbol: Option<String>,
    pub symbols: Option<Vec<String>>,
    pub after_hours: Option<bool>,
    pub intraday_odd_lot: Option<bool>,
}

Subscription request for WebSocket

Modifier flags (after_hours, intraday_odd_lot) are preserved across reconnection so a 盤後 or 盤中零股 subscription comes back as the same session — previous design stored only {channel, symbol} which silently downgraded on resubscribe.

On the wire either symbol (single) or symbols (batch) is populated, never both — see Symbols. The two fields are encoded separately because the Fugle server protocol uses the field presence to drive its ACK shape (subscribed event data is an object for single, array for batch).

Fields

channel: String

Channel to subscribe to

symbol: Option<String>

Stock symbol for the single-symbol path. Mutually exclusive with symbols. Both None is allowed for channel-only subscriptions (e.g. indices) where the server doesn’t require a symbol.

symbols: Option<Vec<String>>

Batch symbol list for the multi-symbol path. Mutually exclusive with symbol. Serializes as symbols: [...] on the wire.

after_hours: Option<bool>

FutOpt after-hours session flag. Sent as afterHours: true on wire when set; absent otherwise so stock path serializes unchanged.

intraday_odd_lot: Option<bool>

Stock intraday odd-lot flag. Sent as intradayOddLot: true on wire when set; absent otherwise.

Implementations

impl SubscribeRequest

pub fn builder() -> SubscribeRequestBuilder

Create an instance of SubscribeRequest using the builder syntax

impl SubscribeRequest

pub fn new(channel: Channel, symbol: impl Into<String>) -> Self

Create a new single-symbol subscription request.

For the polymorphic single/batch variant, use SubscribeRequest::with_symbols.

pub fn with_symbols(channel: Channel, symbols: impl Into<Symbols>) -> Self

Create a subscription request from a Symbols.

Accepts &str / String / Vec<String> / array literal / slice via impl Into<Symbols>. Routes to the symbol or symbols wire field based on the variant.

The input runs through Symbols::normalized before being attached to the request, so duplicate symbols collapse to one subscription and whitespace-only differences are squashed. Empty inputs produce a request with no symbols attached (the dispatch path treats this as a no-op on the wire).

pub fn expand(self) -> Vec<SubscribeRequest>

Expand a batch request into N single-symbol requests.

For wire transmission a batch SubscribeRequest is sent as a single frame with symbols: [...], but for internal bookkeeping (and reconnect replay) each symbol must occupy its own row in SubscriptionManager so that the server’s per-symbol ACK can be recorded against a stable local key. This helper materializes the expansion; single-symbol requests pass through unchanged.

Modifier flags (after_hours, intraday_odd_lot) are duplicated to every expanded entry — batches always share their modifier flags across the symbols they enumerate.

pub fn key(&self) -> String

Generate subscription key for tracking.

Includes modifier suffix so 盤後/零股 subscriptions occupy distinct slots from their regular-session counterparts — the key is the identity used by SubscriptionManager for reconnect, replacement, and unsubscribe lookup.

Trait Implementations

impl Clone for SubscribeRequest

fn clone(&self) -> SubscribeRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribeRequest

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

Formats the value using the given formatter.

impl Default for SubscribeRequest

fn default() -> SubscribeRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscribeRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SubscribeRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SubscribeRequest

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 SubscribeRequest