Trait SubscriptionLike 

pub trait SubscriptionLike {
    // Required methods
    fn is_closed(&self) -> bool;
    fn unsubscribe(&mut self);
}

A SubscriptionLike is something that can be “unsubscribed” from, which will close it, rendering it no longer operational. If it also owns resources, it will also release those resources, usually by executing Teardowns

Drop is mandatory to manually implement for [TeardownCollection], but not for subscribers that do not actually own a teardown, only forward the added teardowns downstream. This is why this bound is only enforced on the Observable::Subscription.

It has to be implemented to guarantee that resources are properly released on drop. Note that some subscriptions do not need to do anything on drop. If that’s the case, the drop fn should only contain a comment on why it doesn’t need to do anything.

Required Methods

fn is_closed(&self) -> bool

Returns if the subscription is closed or not. A subscription can be closed by calling unsubscribe on it. Some special subscriptions made by observables that only ever emit values during subscribe, will produce subscriptions that are created closed.

Once closed, a subscription stays closed.

fn unsubscribe(&mut self)

Releases all resources associated with this subscription, and marks it as closed.

Once closed, a subscription stays closed.

Implementations on Foreign Types

impl SubscriptionLike for InertSubscription

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for Arc<Mutex<Destination>>

where Destination: SubscriptionLike + ?Sized,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for Arc<RwLock<Destination>>

where Destination: SubscriptionLike + ?Sized,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for Weak<Mutex<Destination>>

where Destination: SubscriptionLike + ?Sized,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for DematerializeSubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for EndWithSubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for ErrorBoundarySubscriber<Destination>

where Destination: Subscriber<InError = Infallible>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for IdentitySubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for LiftOptionSubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for MapNeverBothSubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for MapNeverErrorSubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for MapNeverNextSubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for SkipSubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination> SubscriptionLike for TakeSubscriber<Destination>

where Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, Iterator, S> SubscriptionLike for OnTickIteratorSubscription<Destination, Iterator, S>

where Destination: 'static + Subscriber<In = <Iterator as IntoIterator>::Item, InError = Infallible>, Iterator: IntoIterator, <Iterator as IntoIterator>::Item: Signal, S: Scheduler,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, O1, O2> SubscriptionLike for CombineChangesSubscriber<Destination, O1, O2>

where Destination: Subscriber<In = (Change<<O1 as ObservableOutput>::Out>, Change<<O2 as ObservableOutput>::Out>)>, O1: 'static + Observable, <O1 as ObservableOutput>::Out: Clone, <O1 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>, O2: 'static + Observable, <O2 as ObservableOutput>::Out: Clone, <O2 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, O1, O2> SubscriptionLike for CombineLatestSubscriber<Destination, O1, O2>

where Destination: Subscriber<In = (<O1 as ObservableOutput>::Out, <O2 as ObservableOutput>::Out)>, O1: 'static + Observable, <O1 as ObservableOutput>::Out: Clone, <O1 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>, O2: 'static + Observable, <O2 as ObservableOutput>::Out: Clone, <O2 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, O1, O2> SubscriptionLike for JoinSubscriber<Destination, O1, O2>

where Destination: Subscriber<In = (<O1 as ObservableOutput>::Out, <O2 as ObservableOutput>::Out)>, O1: 'static + Observable, <O1 as ObservableOutput>::Out: Clone, <O1 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>, O2: 'static + Observable, <O2 as ObservableOutput>::Out: Clone, <O2 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, O1, O2> SubscriptionLike for ZipSubscriber<Destination, O1, O2>

where Destination: Subscriber<In = (<O1 as ObservableOutput>::Out, <O2 as ObservableOutput>::Out)>, O1: 'static + Observable, <O1 as ObservableOutput>::Out: Clone, <O1 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>, O2: 'static + Observable, <O2 as ObservableOutput>::Out: Clone, <O2 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, S> SubscriptionLike for IntervalSubscription<Destination, S>

where Destination: Subscriber<In = usize>, S: Scheduler,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, S> SubscriptionLike for TimerSubscription<Destination, S>

where Destination: 'static + Subscriber<In = ()>, S: Scheduler,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, S> SubscriptionLike for DebounceTimeSubscriber<Destination, S>

where Destination: 'static + Subscriber, S: 'static + Scheduler + Send + Sync,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, S> SubscriptionLike for DelaySubscriber<Destination, S>

where Destination: 'static + Subscriber, S: 'static + Scheduler + Send + Sync,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, S> SubscriptionLike for ObserveOnSubscriber<Destination, S>

where Destination: 'static + Subscriber, S: 'static + Scheduler + Send + Sync,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Destination, S> SubscriptionLike for ThrottleTimeSubscriber<Destination, S>

where Destination: 'static + Subscriber, S: 'static + Scheduler + Send + Sync,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Filter, Destination> SubscriptionLike for FilterSubscriber<Filter, Destination>

where Filter: for<'a> Fn(&'a <Destination as ObserverInput>::In, usize) -> bool, Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, Destination> SubscriptionLike for BufferCountSubscriber<In, Destination>

where In: Signal, Destination: Subscriber<In = Vec<In>>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, Destination> SubscriptionLike for EnumerateSubscriber<In, Destination>

where In: Signal, Destination: Subscriber<In = (In, usize)>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, Destination> SubscriptionLike for IsEmptySubscriber<In, Destination>

where In: Signal, Destination: Subscriber<In = bool>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, Destination> SubscriptionLike for PairwiseSubscriber<In, Destination>

where In: Signal + Clone, Destination: Subscriber<In = [In; 2]>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError> SubscriptionLike for MulticastSubscription<In, InError>

where In: Signal + Clone, InError: Signal + Clone,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Destination> SubscriptionLike for CountSubscriber<In, InError, Destination>

where In: Signal, InError: Signal, Destination: Subscriber<In = usize, InError = InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Destination> SubscriptionLike for ElementAtSubscriber<In, InError, Destination>

where In: Signal, InError: Signal, Destination: Subscriber<In = In, InError = ElementAtOperatorError<InError>>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Destination> SubscriptionLike for IntoResultSubscriber<In, InError, Destination>

where In: Signal, InError: Signal, Destination: Subscriber<In = Result<In, InError>>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Destination> SubscriptionLike for MaterializeSubscriber<In, InError, Destination>

where In: Signal, InError: Signal, Destination: Subscriber<In = ObserverNotification<In, InError>, InError = Infallible>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, ErrorMapper, OutError, Destination> SubscriptionLike for MapErrorSubscriber<In, InError, ErrorMapper, OutError, Destination>

where In: Signal, InError: Signal, ErrorMapper: FnOnce(InError) -> OutError + Send + Sync, OutError: Signal, Destination: Subscriber<In = In, InError = OutError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Fallback, Destination, S> SubscriptionLike for FallbackWhenSilentSubscriber<In, InError, Fallback, Destination, S>

where In: Signal, InError: Signal, Fallback: 'static + Fn(<S as WithWorkInputOutput>::Tick, &mut <<S as WithWorkContextProvider>::WorkContextProvider as WorkContextProvider>::Item<'_>, usize) -> In + Send + Sync, Destination: Subscriber<In = In, InError = InError>, S: Scheduler,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, HigherOrderSubscriber, ErrorMapper, Destination> SubscriptionLike for HigherOrderAllSubscriber<In, InError, HigherOrderSubscriber, ErrorMapper, Destination>

where In: Signal + Observable, InError: Signal, HigherOrderSubscriber: HigherOrderSubscriberProvider, ErrorMapper: 'static + FnOnce(InError) -> <In as ObservableOutput>::OutError + Send + Sync, Destination: 'static + Subscriber<In = <In as ObservableOutput>::Out, InError = <In as ObservableOutput>::OutError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, InnerObservable, ErrorMapper, Destination> SubscriptionLike for CatchSubscriber<In, InError, InnerObservable, ErrorMapper, Destination>

where In: Signal, InError: Signal, InnerObservable: Observable<Out = In> + Signal, ErrorMapper: 'static + FnOnce(InError) -> InnerObservable + Send + Sync, Destination: 'static + Subscriber<In = In, InError = <InnerObservable as ObservableOutput>::OutError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Mapper, InnerObservable, HigherOrderSubscriber, ErrorMapper, Destination> SubscriptionLike for HigherOrderMapSubscriber<In, InError, Mapper, InnerObservable, HigherOrderSubscriber, ErrorMapper, Destination>

where In: Signal, InError: Signal, Mapper: FnMut(In) -> InnerObservable, InnerObservable: Observable + Signal, HigherOrderSubscriber: HigherOrderSubscriberProvider, ErrorMapper: 'static + FnOnce(InError) -> <InnerObservable as ObservableOutput>::OutError + Send + Sync, Destination: 'static + Subscriber<In = <InnerObservable as ObservableOutput>::Out, InError = <InnerObservable as ObservableOutput>::OutError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Mapper, Out, Destination> SubscriptionLike for MapSubscriber<In, InError, Mapper, Out, Destination>

where In: Signal, InError: Signal, Mapper: Fn(In) -> Out + Send + Sync, Out: Signal, Destination: Subscriber<In = Out, InError = InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, OnNext, Destination> SubscriptionLike for TapNextSubscriber<In, InError, OnNext, Destination>

where OnNext: 'static + FnMut(&In), Destination: Subscriber<In = In, InError = InError>, In: Signal, InError: Signal,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Out, OutError, Destination> SubscriptionLike for MapIntoSubscriber<In, InError, Out, OutError, Destination>

where In: Signal + Into<Out>, InError: Signal + Into<OutError>, Out: Signal, OutError: Signal, Destination: Subscriber<In = Out, InError = OutError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, P, Destination> SubscriptionLike for FindIndexSubscriber<In, InError, P, Destination>

where In: Signal, InError: Signal, P: Fn(&In) -> bool, Destination: Subscriber<In = usize, InError = FindIndexOperatorError<InError>>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Reducer, Out, Destination> SubscriptionLike for ReduceSubscriber<In, InError, Reducer, Out, Destination>

where In: Signal, InError: Signal, Reducer: Fn(&Out, In) -> Out + Send + Sync, Out: Signal + Clone, Destination: Subscriber<In = Out, InError = InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, Reducer, Out, Destination> SubscriptionLike for ScanSubscriber<In, InError, Reducer, Out, Destination>

where In: Signal, InError: Signal, Reducer: Fn(&Out, In) -> Out + Send + Sync, Out: Signal + Clone, Destination: Subscriber<In = Out, InError = InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InError, S> SubscriptionLike for Box<S>

where In: Signal, InError: Signal, S: Subscriber<In = In, InError = InError> + Send + Sync + ?Sized,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<In, InnerObservable, Destination> SubscriptionLike for WithLatestFromSubscriber<In, InnerObservable, Destination>

where In: Signal, InnerObservable: Observable, <InnerObservable as ObservableOutput>::Out: Clone, Destination: Subscriber<In = (In, <InnerObservable as ObservableOutput>::Out), InError = <InnerObservable as ObservableOutput>::OutError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<InError, Destination> SubscriptionLike for FirstSubscriber<InError, Destination>

where InError: Signal, Destination: Subscriber<InError = FirstOperatorError<InError>>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<InError, Destination, S> SubscriptionLike for AdsrSubscriber<InError, Destination, S>

where InError: Signal, Destination: Subscriber<In = AdsrSignal, InError = InError>, S: Scheduler,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<InError, P, Destination> SubscriptionLike for FindSubscriber<InError, P, Destination>

where InError: Signal, P: Fn(&<Destination as ObserverInput>::In) -> bool, Destination: Subscriber<InError = FindOperatorError<InError>>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<Inner, Destination> SubscriptionLike for CompositeSubscriber<Inner, Destination>

where Inner: Subscriber, Destination: RxObserver,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<InnerObservable, Destination> SubscriptionLike for ConcurrentSubscriber<InnerObservable, Destination>

where InnerObservable: Observable<Out = <Destination as ObserverInput>::In, OutError = <Destination as ObserverInput>::InError> + Signal, Destination: 'static + Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<InnerObservable, Destination> SubscriptionLike for ExhaustSubscriber<InnerObservable, Destination>

where InnerObservable: Observable + Signal, Destination: 'static + Subscriber<In = <InnerObservable as ObservableOutput>::Out, InError = <InnerObservable as ObservableOutput>::OutError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<InnerObservable, Destination> SubscriptionLike for SwitchSubscriber<InnerObservable, Destination>

where InnerObservable: Observable + Signal, Destination: 'static + Subscriber<In = <InnerObservable as ObservableOutput>::Out, InError = <InnerObservable as ObservableOutput>::OutError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<O> SubscriptionLike for Option<O>

where O: SubscriptionLike,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<OnNext, Destination> SubscriptionLike for OnNextSubscriber<OnNext, Destination>

where OnNext: 'static + FnMut(&<Destination as ObserverInput>::In, &mut dyn Subscriber<In = <Destination as ObserverInput>::In, InError = <Destination as ObserverInput>::InError>) -> bool + Send + Sync, Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<ResultIn, ResultInError, InError, Destination> SubscriptionLike for LiftResultSubscriber<ResultIn, ResultInError, InError, Destination>

where ResultIn: Signal, ResultInError: Signal, InError: Signal, Destination: Subscriber<In = ResultIn, InError = ResultInError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<State, OnComplete, OnUnsubscribe, Destination> SubscriptionLike for HigherOrderInnerSubscriber<State, OnComplete, OnUnsubscribe, Destination>

where State: HigherOrderSubscriberStateConditions, OnComplete: FnOnce(usize), OnUnsubscribe: FnOnce(usize), Destination: 'static + Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<TapDestination, Destination> SubscriptionLike for TapSubscriber<TapDestination, Destination>

where TapDestination: 'static + RxObserver<In = <Destination as ObserverInput>::In, InError = <Destination as ObserverInput>::InError> + Send + Sync, Destination: Subscriber,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

impl<VariantSelector, Destination, O1, O2> SubscriptionLike for EitherSubscriber2<VariantSelector, Destination, O1, O2>

where VariantSelector: EitherNotificationSelector2<O1, O2>, Destination: Subscriber<In = EitherObservableNotification2<O1, O2>>, O1: Observable, <O1 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>, O2: Observable, <O2 as ObservableOutput>::OutError: Into<<Destination as ObserverInput>::InError>,

fn is_closed(&self) -> bool

fn unsubscribe(&mut self)

Implementors

impl SubscriptionLike for ErasedSubscription

impl SubscriptionLike for SharedSubscription

impl SubscriptionLike for SubscriptionData

impl<Destination> SubscriptionLike for ObserverSubscriber<Destination>

where Destination: RxObserver,

impl<Destination> SubscriptionLike for SharedSubscriber<Destination>

where Destination: 'static + Subscriber + Send + Sync,

impl<Destination> SubscriptionLike for Subscription<Destination>

where Destination: Subscriber,

impl<In, InError> SubscriptionLike for PrintObserver<In, InError>

where In: Signal + Debug, InError: Signal + Debug,

impl<In, InError> SubscriptionLike for ErasedSubscriber<In, InError>

where In: Signal, InError: Signal,

impl<In, InError> SubscriptionLike for BehaviorSubject<In, InError>

where In: Signal + Clone, InError: Signal + Clone,

impl<In, InError> SubscriptionLike for PublishSubject<In, InError>

where In: Signal + Clone, InError: Signal + Clone,

A subject is both an observable and an observer, but they are NOT subscriptions! And traditionally they do not allow to forcibly unsubscribe all subscribers, besides just marking the subject as closed once completed or errored.

The reason is, that when a subject is used as a destination of a subscription, it should only forward signals, but should definitely NOT unsubscribe the subscribers. That subject could be used as a destination for multiple subscriptions, one should not close it from others, unless it completes or errors it.

But here that does not happen, because Observables here in rx_core expect not an observer, but an UpgradeableObserver. And it’s up to the destination to decide if it wants to be unsubscribed together with upstream or not. (This exists to be able to use subscribers directly as destinations)

This trait is autoimplemented by the RxSubject macro and makes subjects always be wrapped in a DetatchedSubscriber which only forwards signals but not unsubscribe calls.

Publish, Behavior, Replay and Async subjects all upgrade to a detached subscriber, but other subjects implement it at their own discretion. The RxSubject macro intentionally makes this the default behavior, so if a custom subject does not detach on subscribe, it’s most likely intentional.

So you get to pass subjects as destinations without worrying that it unsubscribes when it shouldn’t, but you can still do it by hand and drop all subscribers.

impl<In, InError, Reducer> SubscriptionLike for AsyncSubject<In, InError, Reducer>

where Reducer: 'static + FnMut(In, In) -> In + Send + Sync, In: Signal + Clone, InError: Signal + Clone,

impl<InnerSubscriber, Destination> SubscriptionLike for OptionSubscriber<InnerSubscriber, Destination>

where InnerSubscriber: Subscriber, Destination: Subscriber<In = <InnerSubscriber as ObserverInput>::In, InError = <InnerSubscriber as ObserverInput>::InError>, <InnerSubscriber as ObserverInput>::In: 'static, <InnerSubscriber as ObserverInput>::InError: 'static,

impl<Provenance, In, InError> SubscriptionLike for ProvenanceSubject<Provenance, In, InError>

where Provenance: Signal + Clone + PartialEq, In: Signal + Clone, InError: Signal + Clone,

impl<S> SubscriptionLike for OptionSubscription<S>

where S: SubscriptionWithTeardown,

impl<Subscription> SubscriptionLike for ConnectionHandle<Subscription>

where Subscription: SubscriptionWithTeardown,

impl<const CAPACITY: usize, In, InError> SubscriptionLike for ReplaySubject<CAPACITY, In, InError>

where In: Signal + Clone, InError: Signal + Clone,