Struct Subscription 

pub struct Subscription {
    pub id: String,
    pub client_id: String,
    pub subscription_type: SubscriptionType,
    pub filter: Option<SubscriptionFilter>,
}

A subscription to WebSocket updates.

Fields

id: String

Unique subscription ID

client_id: String

Client ID that owns this subscription

subscription_type: SubscriptionType

Subscription type

filter: Option<SubscriptionFilter>

Optional filter

Implementations

impl Subscription

pub fn new( client_id: String, subscription_type: SubscriptionType, filter: Option<SubscriptionFilter>, ) -> Self

Create a new subscription.

pub fn tiles( client_id: String, bbox: [f64; 4], zoom_range: Range<u8>, filter: Option<SubscriptionFilter>, ) -> Self

Create a tile subscription.

pub fn features( client_id: String, layer: Option<String>, filter: Option<SubscriptionFilter>, ) -> Self

Create a feature subscription.

pub fn events( client_id: String, event_types: HashSet<EventType>, filter: Option<SubscriptionFilter>, ) -> Self

Create an event subscription.

pub fn matches_tile(&self, tile_x: u32, tile_y: u32, zoom: u8) -> bool

Check if a tile matches this subscription.

pub fn matches_feature(&self, layer: Option<&str>) -> bool

Check if a feature matches this subscription.

pub fn matches_event(&self, event_type: EventType) -> bool

Check if an event matches this subscription.

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.