ObserversHolder

Struct ObserversHolder 

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

Optional convenience mechanism to aid in managing dynamic Observers instances.

Intended to be used as:

use coap_server::app::{ObservableResource, Observers, ObserversHolder};
struct MyResource {
    holder: ObserversHolder
}
#[async_trait::async_trait]
impl ObservableResource for MyResource {
    async fn on_active(&self, observers: Observers) -> Observers {
        let attached = self.holder.attach(observers).await;
        attached.stay_active().await;
        attached.detach().await
    }
}

Implementations§

Source§

impl ObserversHolder

Source

pub fn new() -> Self

Source

pub async fn attach(&self, observers: Observers) -> Attached<'_>

Attach a new Observers instance which affects how [notify_change] behaves.

Source

pub async fn notify_change(&self)

Defers to Observers::notify_change when attached; does nothing otherwise.

Source

pub async fn notify_change_for_path(&self, relative_path: &str)

Special variation of [notify_change] that indicates only observe requests grouped under the provided path should be notified of the change. This optimization can help a lot when you are observing dynamic resources (i.e. /resources/{resource_name}/) with a very large number of updates across different resources.

The provided relative_path is used for fuzzy matching of any “relevant” observing path. For example, if relative_path is "resources/abc" then it will match against observe requests for "resources/abc/some_property", "resources/abc", or even "resources". It would not match observe requests for "/resources/xyz".

relative_path is relative to the resource path that the crate::app::ObservableResource was installed at.

Trait Implementations§

Source§

impl Clone for ObserversHolder

Source§

fn clone(&self) -> ObserversHolder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ObserversHolder

Source§

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

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

impl Default for ObserversHolder

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V