Struct SubscriptionHandle 

pub struct SubscriptionHandle { /* private fields */ }

Handle for an active document subscription

Drop this handle to unsubscribe from document changes.

Implementations

impl SubscriptionHandle

pub fn is_active(&self) -> bool

Check if the subscription is still active

pub fn cancel(&self)

Cancel the subscription

pub fn poll_changes(&self) -> Vec<DocumentChange>

Drain all pending document changes. Non-blocking.

Only populated when the subscription was opened via PeatNode::subscribe_poll. Always returns an empty Vec for subscriptions opened via PeatNode::subscribe (callback path).

Trait Implementations

impl Drop for SubscriptionHandle

Available on crate feature sync only.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<UT> LiftRef<UT> for SubscriptionHandle

type LiftType = Arc<SubscriptionHandle>

impl<UT> LowerError<UT> for SubscriptionHandle

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SubscriptionHandle

type ReturnType = <Arc<SubscriptionHandle> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for SubscriptionHandle

const TYPE_ID_META: MetadataBuffer