Struct CaptureHandle

Source
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.

Source

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());
Source

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());
Source

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());
Source

pub fn request_window(&self, window_id: impl Into<String>) -> CaptureRequestId

Enqueues a default-parameter full-window capture and returns its id.

§Panics

Panics if the shared capture-state mutex is poisoned.

§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
assert_eq!(captures.request_window("main"), 1);
Source

pub fn request_element( &self, window_id: impl Into<String>, key: impl Into<String>, ) -> CaptureRequestId

Enqueues a default-parameter capture of one exactly keyed element.

§Panics

Panics if the shared capture-state mutex is poisoned.

§Examples
let captures = ailloli_ui_winit::CaptureHandle::new();
let id = captures.request_element("main", "editor");
assert_eq!(id, 1);
Source

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);
Source

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());
Source

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());
Source

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"));
Source

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());
Source

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());
Source

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());
Source

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

Source§

fn clone(&self) -> CaptureHandle

Returns a copy 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 CaptureHandle

Source§

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

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

impl Default for CaptureHandle

Source§

fn default() -> CaptureHandle

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &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
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Props for T
where T: Clone + 'static,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,