Struct QlStatus 

pub struct QlStatus<P> { /* private fields */ }

reactive handle to latest QuantumLink status

Implementations

impl<P> QlStatus<P>

where P: CheckedPermissions + 'static,

pub fn new(worker: WorkerHandle) -> Self

where P: MessageAllowed<SubscribeConnectionStatus> + 'static,

Permission: os/quantum-link / SubscribeConnectionStatus

Groups: network-and-pairing.device-link-status

Sender policy: signed

Grant timing: install-review

pub async fn ready(&self)

Permission: none

wait until bluetooth is connected, device is paired, and connection is confirmed as live

pub async fn bt_ready(&self)

Permission: none

wait until bluetooth is connected

pub fn is_connected(&self) -> bool

Permission: none

check if fully connected (BT + paired)

pub fn send_ql_archive<M>(&self, msg: M) -> impl Future<Output = M::Response>

where P: MessageAllowed<M>, M: BlockingArchive + Send + 'static, M::Response: Send,

Permission: TBD (MessageAllowed<M>)

Groups: TBD

Sender policy: TBD

Grant timing: TBD

pub fn send_ql_archive_retry<M, T, E>( &self, msg: M, error: impl FnMut(E) + Send + 'static, ) -> impl Future<Output = T>

where P: CheckedPermissions + MessageAllowed<M>, M: BlockingArchive<Response = Result<T, E>> + Send + Clone + 'static, M::Response: Send, T: ArchiveCodec + Send + 'static, <T as Archive>::Archived: Deserialize<T, XousDeserializer> + for<'a> CheckBytes<XousValidator<'a>>, E: ArchiveCodec + Send + 'static, <E as Archive>::Archived: Deserialize<E, XousDeserializer> + for<'a> CheckBytes<XousValidator<'a>>,

Permission: TBD (MessageAllowed<M>)

Groups: TBD

Sender policy: TBD

Grant timing: TBD

pub fn into_inner(self) -> StreamWatch<ConnectionStatus>

Permission: none

Methods from Deref<Target = StreamWatch<ConnectionStatus>>

pub async fn wait_until(&self, predicate: impl FnMut(&T) -> bool)

wait until a predicate is satisfied.

pub fn current(&self) -> T

get the current value

pub fn borrow(&self) -> Ref<'_, T>

borrow the current value

pub async fn next(&mut self) -> Option<T>

wait for the next event

Trait Implementations

impl<P: Clone> Clone for QlStatus<P>

fn clone(&self) -> QlStatus<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Deref for QlStatus<P>

type Target = StreamWatch<ConnectionStatus>

The resulting type after dereferencing.

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

Dereferences the value.

impl<P> DerefMut for QlStatus<P>

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

Mutably dereferences the value.