Skip to main content

CustomAction

Enum CustomAction 

Source
pub enum CustomAction {
Show 46 variants Cmd(&'static [&'static str]), CmdLog(LogLevel, LogLevel, &'static [&'static str]), CmdOutputKeys(&'static [&'static str]), PushMessage(&'static [SimpleSExpr]), Unicode(char), Mouse(Btn), MouseTap(Btn), FakeKey { coord: Coord, action: FakeKeyAction, }, FakeKeyOnRelease { coord: Coord, action: FakeKeyAction, }, FakeKeyOnIdle(FakeKeyOnIdle), FakeKeyOnPhysicalIdle(FakeKeyOnIdle), FakeKeyHoldForDuration(FakeKeyHoldForDuration), Delay(u16), DelayOnRelease(u16), MWheel { direction: MWheelDirection, interval: u16, distance: u16, inertial_scroll_params: Option<&'static MWheelInertial>, }, MWheelNotch { direction: MWheelDirection, }, MoveMouse { direction: MoveDirection, interval: u16, distance: u16, }, MoveMouseAccel { direction: MoveDirection, interval: u16, accel_time: u16, min_distance: u16, max_distance: u16, }, MoveMouseSpeed { speed: u16, }, SequenceCancel, SequenceLeader(u16, SequenceInputMode), SequenceNoerase(u16), LiveReload, LiveReloadNext, LiveReloadPrev, LiveReloadNum(u16), LiveReloadFile(&'static str), Repeat, CancelMacroOnRelease, CancelMacroOnNextPress(u32), DynamicMacroRecord(u16), DynamicMacroRecordStop(u16), DynamicMacroPlay(u16), SendArbitraryCode(u16), CapsWord(CapsWordCfg), SetMouse { x: u16, y: u16, }, Unmodded { keys: &'static [KeyCode], mods: UnmodMods, }, Unshifted { keys: &'static [KeyCode], }, ReverseReleaseOrder, ClipboardSet(&'static str), ClipboardCmdSet(&'static [&'static str]), ClipboardSave(u16), ClipboardRestore(u16), ClipboardSaveSet(u16, &'static str), ClipboardSaveCmdSet(u16, &'static [&'static str]), ClipboardSaveSwap(u16, u16),
}

Variants§

§

Cmd(&'static [&'static str])

§

CmdLog(LogLevel, LogLevel, &'static [&'static str])

§

CmdOutputKeys(&'static [&'static str])

§

PushMessage(&'static [SimpleSExpr])

§

Unicode(char)

§

Mouse(Btn)

§

MouseTap(Btn)

§

FakeKey

Fields

§coord: Coord
§

FakeKeyOnRelease

Fields

§coord: Coord
§

FakeKeyOnIdle(FakeKeyOnIdle)

§

FakeKeyOnPhysicalIdle(FakeKeyOnIdle)

§

FakeKeyHoldForDuration(FakeKeyHoldForDuration)

§

Delay(u16)

§

DelayOnRelease(u16)

§

MWheel

Fields

§interval: u16
§distance: u16
§inertial_scroll_params: Option<&'static MWheelInertial>
§

MWheelNotch

Fields

§

MoveMouse

Fields

§direction: MoveDirection
§interval: u16
§distance: u16
§

MoveMouseAccel

Fields

§direction: MoveDirection
§interval: u16
§accel_time: u16
§min_distance: u16
§max_distance: u16
§

MoveMouseSpeed

Fields

§speed: u16
§

SequenceCancel

§

SequenceLeader(u16, SequenceInputMode)

§

SequenceNoerase(u16)

Purpose: In case the user has dead keys in their OS layout, they may wish to send fewer backspaces upon a successful completion of visible-backspaced sequences, because the number of key events is larger than the number of backspace-able symbols typed within the application. This custom action is a marker to accomplish the use case.

§

LiveReload

§

LiveReloadNext

§

LiveReloadPrev

§

LiveReloadNum(u16)

Live-reload the n’th configuration file provided on the CLI. This should begin with 0 as the first configuration file provided. The rest of the parser code is free to choose 0 or 1 as the user-facing value though.

§

LiveReloadFile(&'static str)

§

Repeat

§

CancelMacroOnRelease

§

CancelMacroOnNextPress(u32)

§

DynamicMacroRecord(u16)

§

DynamicMacroRecordStop(u16)

§

DynamicMacroPlay(u16)

§

SendArbitraryCode(u16)

§

CapsWord(CapsWordCfg)

§

SetMouse

Fields

§

Unmodded

Fields

§keys: &'static [KeyCode]
§

Unshifted

Fields

§keys: &'static [KeyCode]
§

ReverseReleaseOrder

§

ClipboardSet(&'static str)

§

ClipboardCmdSet(&'static [&'static str])

§

ClipboardSave(u16)

§

ClipboardRestore(u16)

§

ClipboardSaveSet(u16, &'static str)

§

ClipboardSaveCmdSet(u16, &'static [&'static str])

§

ClipboardSaveSwap(u16, u16)

Trait Implementations§

Source§

impl Clone for CustomAction

Source§

fn clone(&self) -> CustomAction

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 Debug for CustomAction

Source§

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

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

impl Eq for CustomAction

Source§

impl Hash for CustomAction

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CustomAction

Source§

fn eq(&self, other: &CustomAction) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CustomAction

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black
Source§

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black
Source§

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red
Source§

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red
Source§

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green
Source§

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green
Source§

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow
Source§

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue
Source§

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta
Source§

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple
Source§

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan
Source§

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white
Source§

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white
Source§

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold
Source§

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim
Source§

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized
Source§

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors
Source§

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text
Source§

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
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.