Struct NativeOutputProbeService

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

Dedicated native-output probe and calibration-marker worker.

On Linux, connection starts one named thread and each synchronous command waits at most six seconds. Other platforms return NativeOverlayError::Unsupported. Dropping or consuming the service sends shutdown and joins the worker.

§Examples

let service: ailloli_ui_winit::NativeOutputProbeService =
    ailloli_ui_winit::NativeOutputProbeService::connect().unwrap();
service.shutdown();

Implementations§

Source§

impl NativeOutputProbeService

Probe lifecycle and synchronous command interface.

Source

pub fn connect() -> Result<Self, NativeOverlayError>

Connects to the native output protocol and starts the worker.

§Errors

Returns Unsupported off Linux, or a backend/timeout error if the worker cannot start and initialize within six seconds.

§Examples
let service = ailloli_ui_winit::NativeOutputProbeService::connect()?;
service.shutdown();
Source

pub fn snapshot_outputs( &self, ) -> Result<Vec<NativeOutputDescriptor>, NativeOverlayError>

Returns the current generation-stamped output catalogue.

§Errors

Returns Unsupported off Linux, Closed if the worker ended, or a backend timeout/error if no reply arrives within six seconds.

§Examples
let service = ailloli_ui_winit::NativeOutputProbeService::connect()?;
let outputs: Vec<ailloli_ui_winit::NativeOutputDescriptor> = service.snapshot_outputs()?;
Source

pub fn show_marker( &self, descriptor: &NativeOutputDescriptor, spec: NativeCalibrationMarkerSpec, ) -> Result<NativeCalibrationMarkerGuard, NativeOverlayError>

Shows a temporary marker for one descriptor and returns its RAII guard.

The worker rejects a descriptor from a stale catalogue generation. Success means the compositor acknowledged and the marker buffer was presented. Only one marker is active; showing another replaces it.

§Errors

Returns platform, stale-descriptor, channel, timeout, or backend failures.

§Examples
let service = ailloli_ui_winit::NativeOutputProbeService::connect()?;
let output = service.snapshot_outputs()?.remove(0);
let guard: ailloli_ui_winit::NativeCalibrationMarkerGuard = service.show_marker(
    &output,
    ailloli_ui_winit::NativeCalibrationMarkerSpec::new(123, 0),
)?;
guard.hide()?;
Source

pub fn hide_marker(&self) -> Result<(), NativeOverlayError>

Explicitly removes the active marker, if any.

§Errors

Returns platform, closed-worker, timeout, or backend errors. Hiding when no marker is active is successful.

§Examples
let service = ailloli_ui_winit::NativeOutputProbeService::connect()?;
service.hide_marker()?;
Source

pub fn shutdown(self)

Sends shutdown and joins the worker before returning.

Command-send and worker-panic failures are deliberately ignored during teardown.

§Examples
let service = ailloli_ui_winit::NativeOutputProbeService::connect()?;
service.shutdown();

Trait Implementations§

Source§

impl Debug for NativeOutputProbeService

Hides platform channel details from debug output.

Source§

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

Omits worker-channel internals while identifying the service type.

Source§

impl Drop for NativeOutputProbeService

Ensures a live probe worker is stopped and joined on scope exit.

Source§

fn drop(&mut self)

Requests shutdown and joins the worker at most once.

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
§

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.

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<T> Same for T

Source§

type Output = T

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