Struct aldrin::DiscovererStream

pub struct DiscovererStream<Key, const N: usize> { /* private fields */ }

Stream adapter for Discoverer.

Methods from Deref<Target = Discoverer<Key>>

pub fn client(&self) -> &Handle

Returns a handle to the client that was used to create the discoverer.

pub async fn restart(&mut self) -> Result<(), Error>

Restarts the discoverer.

All pending events will be discarded. The discoverer will be configured to consider all objects and services on the bus, as if it was built again with DiscovererBuilder::build.

pub async fn restart_current_only(&mut self) -> Result<(), Error>

Restarts the discoverer and configures it to consider only current objects and services.

All pending events will be discarded. The discoverer will be configured to consider only current objects and services on the bus, as if it was built again with DiscovererBuilder::build_current_only.

pub fn is_finished(&self) -> bool

Indicates whether the discoverer can return more events.

Discoverers can only finish if they are considering only current objects and services, i.e. built with build_current_only or restarted with restart_current_only.

pub fn poll_next_event_ref( &mut self, cx: &mut Context<'_> ) -> Poll<Option<DiscovererEventRef<'_, Key>>>

Poll the discoverer for an event.

pub async fn next_event_ref(&mut self) -> Option<DiscovererEventRef<'_, Key>>

Awaits an event from the discoverer.

pub fn poll_next_event<const N: usize>( &mut self, cx: &mut Context<'_> ) -> Poll<Option<DiscovererEvent<Key, N>>>

Poll the discoverer for an event.

pub async fn next_event<const N: usize>( &mut self ) -> Option<DiscovererEvent<Key, N>>

Awaits an event from the discoverer.

Trait Implementations

impl<Key: Debug, const N: usize> Debug for DiscovererStream<Key, N>

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

Formats the value using the given formatter.

impl<Key, const N: usize> Deref for DiscovererStream<Key, N>

type Target = Discoverer<Key>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Key, const N: usize> DerefMut for DiscovererStream<Key, N>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<Key, const N: usize> FusedStream for DiscovererStream<Key, N>

where Key: Clone,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<Key, const N: usize> Stream for DiscovererStream<Key, N>

where Key: Clone,

type Item = DiscovererEvent<Key, N>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.