pub struct CaptureHandle { /* private fields */ }Expand description
Thread-safe queue of window/element capture requests for UiApp.
When attached through WinitHost, a request made
while the native event loop is waiting wakes the host and schedules a
redraw. Requests made before the event-loop proxy exists are retained and
wake it once the proxy is installed.
Clones share one mutex-protected queue. Requests and completion listeners may be submitted from any thread. A poisoned mutex causes read/drain helpers to return conservative empty values, while request submission treats poisoning as a programmer error and panics.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
let clone = captures.clone();
let id = clone.request_window("main");
assert_eq!(id, 1);
assert!(captures.has_pending_for_window("main"));Implementations§
Source§impl CaptureHandle
Request submission, wake coordination, completion, and result drains.
impl CaptureHandle
Request submission, wake coordination, completion, and result drains.
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates an empty shared capture queue.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
assert!(!captures.has_pending());
assert!(!captures.is_complete());Sourcepub fn set_exit_after_all_captures(&self, value: bool)
pub fn set_exit_after_all_captures(&self, value: bool)
Sets whether the host should exit after all issued requests leave the pending queue.
The flag defaults to false. A poisoned state mutex leaves the previous
value unchanged.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
captures.set_exit_after_all_captures(true);
assert!(captures.exit_after_all_captures());Sourcepub fn exit_after_all_captures(&self) -> bool
pub fn exit_after_all_captures(&self) -> bool
Returns the configured automatic-exit flag.
Returns false if the state mutex is poisoned.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
assert!(!captures.exit_after_all_captures());Sourcepub fn request_window(&self, window_id: impl Into<String>) -> CaptureRequestId
pub fn request_window(&self, window_id: impl Into<String>) -> CaptureRequestId
Sourcepub fn request_element(
&self,
window_id: impl Into<String>,
key: impl Into<String>,
) -> CaptureRequestId
pub fn request_element( &self, window_id: impl Into<String>, key: impl Into<String>, ) -> CaptureRequestId
Sourcepub fn request(
&self,
target: CaptureTarget,
params: CaptureParams,
) -> CaptureRequestId
pub fn request( &self, target: CaptureTarget, params: CaptureParams, ) -> CaptureRequestId
Enqueues a capture with explicit target and renderer parameters.
IDs and the issued counter saturate. Wake requests coalesce until the host begins service; queued work is retained if waking fails.
§Panics
Panics if the shared capture-state mutex is poisoned.
§Examples
use ailloli_ui_render_wgpu::CaptureParams;
use ailloli_ui_winit::{CaptureHandle, CaptureTarget};
let captures = CaptureHandle::new();
let id = captures.request(CaptureTarget::window("main"), CaptureParams::default());
assert_eq!(id, 1);Sourcepub fn take_wake_error(&self) -> Option<UiWakeError>
pub fn take_wake_error(&self) -> Option<UiWakeError>
Takes the first non-fatal error raised while waking the native host.
Capture requests remain queued when waking fails. A later host
attachment can therefore service the request without the caller
retrying it and accidentally issuing a second capture.
The first stored error is consumed; mutex poisoning returns None.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
assert!(captures.take_wake_error().is_none());Sourcepub fn has_pending(&self) -> bool
pub fn has_pending(&self) -> bool
Returns whether any request remains unclaimed by a window redraw.
Returns false if the mutex is poisoned.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
captures.request_window("main");
assert!(captures.has_pending());Sourcepub fn has_pending_for_window(&self, window_id: &str) -> bool
pub fn has_pending_for_window(&self, window_id: &str) -> bool
Returns whether a pending request targets exactly window_id.
Returns false if the mutex is poisoned. Element and full-window
requests use the same logical window comparison.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
captures.request_element("main", "button");
assert!(captures.has_pending_for_window("main"));
assert!(!captures.has_pending_for_window("other"));Sourcepub fn is_complete(&self) -> bool
pub fn is_complete(&self) -> bool
Reports that at least one request was issued and none remains pending.
This tracks request claiming, not result consumption: a renderer may
still be producing a claimed result, and completed results may remain queued.
Mutex poisoning returns false.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
assert!(!captures.is_complete());Sourcepub fn take_result(
&self,
id: CaptureRequestId,
) -> Option<Result<CaptureResult, CaptureError>>
pub fn take_result( &self, id: CaptureRequestId, ) -> Option<Result<CaptureResult, CaptureError>>
Removes and returns the completed result with exactly id.
Results with other ids retain completion order. Unknown ids and mutex
poisoning return None.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
assert!(captures.take_result(99).is_none());Sourcepub fn take_all_results(&self) -> Vec<Result<CaptureResult, CaptureError>>
pub fn take_all_results(&self) -> Vec<Result<CaptureResult, CaptureError>>
Drains all completed results in completion order, without their ids.
Returns an empty vector when there are no results or the mutex is poisoned.
§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
assert!(captures.take_all_results().is_empty());Sourcepub fn on_complete(
&self,
listener: Arc<dyn Fn(CaptureRequestId, &Result<CaptureResult, CaptureError>) + Send + Sync>,
)
pub fn on_complete( &self, listener: Arc<dyn Fn(CaptureRequestId, &Result<CaptureResult, CaptureError>) + Send + Sync>, )
Registers a listener invoked on each completed or failed capture request.
Listeners accumulate and run in registration order. Each invocation uses a cloned listener list after releasing the mutex, so callbacks may safely enqueue another request. Mutex poisoning silently declines registration.
§Examples
use std::sync::Arc;
let captures = ailloli_ui_winit::CaptureHandle::new();
captures.on_complete(Arc::new(|id, result| {
let _: ailloli_ui_winit::CaptureRequestId = id;
let _succeeded: bool = result.is_ok();
}));Trait Implementations§
Source§impl Clone for CaptureHandle
impl Clone for CaptureHandle
Source§fn clone(&self) -> CaptureHandle
fn clone(&self) -> CaptureHandle
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CaptureHandle
impl Debug for CaptureHandle
Source§impl Default for CaptureHandle
impl Default for CaptureHandle
Source§fn default() -> CaptureHandle
fn default() -> CaptureHandle
Auto Trait Implementations§
impl Freeze for CaptureHandle
impl RefUnwindSafe for CaptureHandle
impl Send for CaptureHandle
impl Sync for CaptureHandle
impl Unpin for CaptureHandle
impl UnwindSafe for CaptureHandle
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<A> IntoClickAction<A> for Awhere
A: Clone + 'static,
impl<A> IntoClickAction<A> for Awhere
A: Clone + 'static,
§fn into_click_action(self) -> ClickAction<A>
fn into_click_action(self) -> ClickAction<A>
Implements the into_click_action helper used by this module.
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian().