Struct watchman_client::Subscription

pub struct Subscription<F> where
    F: DeserializeOwned + Debug + Clone + QueryFieldList,  { /* fields omitted */ }

A handle to a subscription initiated via Client::subscribe. Repeatedly call Subscription::next().await to yield the next set of subscription results. Use the cancel method to gracefully halt this subscription if you have a program that creates and destroys subscriptions throughout its lifetime.

Implementations

impl<F> Subscription<F> where
    F: DeserializeOwned + Debug + Clone + QueryFieldList, 

pub fn name(&self) -> &str

Returns the assigned name for this subscription instance.

pub async fn next(&mut self) -> Result<SubscriptionData<F>, Error>

Yield the next set of subscription data. An error is generated if the subscription is disconnected from the server.

pub async fn cancel(self) -> Result<(), Error>

Gracefully cancel this subscription. If you are imminently about to drop the associated client then you need not call this method. However, if the associated client is going to live much longer than a Subscription that you are about to drop, then it is recommended that you call cancel so that the server will stop delivering data about it.