Skip to main content

BindingScope

Struct BindingScope 

Source
pub struct BindingScope { /* private fields */ }
Expand description

Collects subscriptions and bindings for a logical scope (e.g., a widget).

When the scope is dropped, all held subscriptions are released, cleanly disconnecting all reactive bindings associated with that scope.

§Usage

let mut scope = BindingScope::new();

let obs = Observable::new(42);
scope.subscribe(&obs, |v| println!("value: {v}"));
scope.bind(&obs, |v| format!("display: {v}"));

// When scope drops, all subscriptions are released.

§Invariants

  1. Subscriptions are released in reverse registration order on drop.
  2. After drop, no callbacks from this scope will fire.
  3. clear() releases all subscriptions immediately (reusable scope).
  4. Binding count is always accurate.

Implementations§

Source§

impl BindingScope

Source

pub fn new() -> Self

Create an empty binding scope.

Source

pub fn hold(&mut self, sub: Subscription)

Add a subscription to this scope. The subscription will be held alive until the scope is dropped or clear() is called.

Source

pub fn subscribe<T: Clone + PartialEq + 'static>( &mut self, source: &Observable<T>, callback: impl Fn(&T) + 'static, ) -> &mut Self

Subscribe to an observable within this scope.

Returns a reference to the scope for chaining.

Source

pub fn bind<T: Clone + PartialEq + 'static>( &mut self, source: &Observable<T>, ) -> Binding<T>

Create a one-way binding within this scope.

The binding’s underlying subscription is held by the scope. Returns the Binding<T> for reading the value.

Source

pub fn bind_map<S: Clone + PartialEq + 'static, T: 'static>( &mut self, source: &Observable<S>, map: impl Fn(&S) -> T + 'static, ) -> Binding<T>

Create a mapped binding within this scope.

Source

pub fn binding_count(&self) -> usize

Number of active subscriptions/bindings in this scope.

Source

pub fn is_empty(&self) -> bool

Whether the scope has no active bindings.

Source

pub fn clear(&mut self)

Release all subscriptions immediately (scope becomes empty but reusable).

Trait Implementations§

Source§

impl Debug for BindingScope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BindingScope

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more