Skip to main content

Effect

Enum Effect 

Source
pub enum Effect<'a> {
    None,
    Click(MouseButton),
    Shortcut(Shortcut),
    Key(&'a KeyCombo),
    Scroll {
        dx: i8,
        dy: i8,
    },
    Media(MediaKey),
    Native(NativeAction),
    Script(Script<'a>),
    Text(&'a str),
    AgentSide,
}
Expand description

What firing an Action should do, independent of platform.

openlogi_inject’s per-OS backends match on this instead of on Action directly.

Variants§

§

None

Suppress the input entirely: no OS event at all.

§

Click(MouseButton)

Synthesise a physical mouse button click.

§

Shortcut(Shortcut)

Fire a named shortcut. Each backend maps this to its own platform chord (or, for the rare shortcut with no chord at all on some OS, a dedicated native code path) — see that backend’s combo table.

§

Key(&'a KeyCombo)

Press an already-resolved keyboard chord: a user-recorded Action::CustomShortcut, or a workflow’s PressKey step.

§

Scroll

Synthesise one scroll tick. dx/dy are unit direction (-1/0/1); each backend applies its own tick magnitude.

Fields

§dx: i8

Horizontal direction: -1 left, 1 right, 0 none.

§dy: i8

Vertical direction: -1 down, 1 up, 0 none.

§

Media(MediaKey)

Fire a media/volume key. Every backend reaches these through a dedicated OS mechanism rather than an ordinary keyboard chord.

§

Native(NativeAction)

A window-manager or power action with no shared cross-platform chord — each backend has its own dedicated handling, which may be a debug-logged no-op where the OS has no equivalent at all.

§

Script(Script<'a>)

A power-user scripting escape hatch.

§

Text(&'a str)

Type this text via unicode input.

§

AgentSide

Handled entirely by the agent/hook layer — DPI presets, SmartShift, the Actions Ring, and launching an application. The injector logs and does nothing.

Action::OpenApplication is included here even though openlogi_inject::execute does open it: that happens in the platform-independent dispatcher before a backend ever sees the action (the config target is opened via the opener crate, not through any per-OS synthesis path), so from a backend’s point of view it is exactly as much a no-op as the DPI actions.

Trait Implementations§

Source§

impl<'a> Clone for Effect<'a>

Source§

fn clone(&self) -> Effect<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Effect<'a>

Source§

impl<'a> Debug for Effect<'a>

Source§

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

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

impl<'a> Eq for Effect<'a>

Source§

impl<'a> PartialEq for Effect<'a>

Source§

fn eq(&self, other: &Effect<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for Effect<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Effect<'a>

§

impl<'a> RefUnwindSafe for Effect<'a>

§

impl<'a> Send for Effect<'a>

§

impl<'a> Sync for Effect<'a>

§

impl<'a> Unpin for Effect<'a>

§

impl<'a> UnsafeUnpin for Effect<'a>

§

impl<'a> UnwindSafe for Effect<'a>

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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