https://github.com/risoflora/lock_keys

Rust library for lock keys handling.
https://github.com/risoflora/lock_keys

capslock lock-keys numlock rust scrolllock

Last synced: about 1 month ago
JSON representation

Rust library for lock keys handling.

• Host: GitHub
• URL: https://github.com/risoflora/lock_keys
• Owner: risoflora
• License: apache-2.0
• Created: 2019-12-21T12:17:12.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-02T23:59:27.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T11:47:57.307Z (about 2 months ago)
• Topics: capslock, lock-keys, numlock, rust, scrolllock
• Language: Rust
• Homepage: https://crates.io/crates/lock_keys
• Size: 16.6 KB
• Stars: 5
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# `lock_keys`

[![CI/CD][ci-cd-badge]][ci-cd-url]

[![Crates.io][crates-badge]][crates-url]

[![Documentation][docs-badge]][docs-url]

[![License][license-badge]][license-url]

`lock_keys` provides a cross platform way for lock keys handling.

Supported platforms: Linux ([Xlib][xlib-wiki-url] static),

Windows ([winuser API][winuser-api-url]) and macOS ([IOKit][iokit-url]).

## Usage

Add this to your `Cargo.toml`:

```ini

[dependencies]

lock_keys = "*"

```

and then:

```rust

use lock_keys::*;

fn main() {

    let lock_key = LockKey::new();

    lock_key.enable(LockKeys::CapitalLock).unwrap();

}

```

## Contributions

Pull Requests are welcome! =)

## License

`lock_keys` is licensed under either of the following, at your option:

- [Apache License 2.0](LICENSE-APACHE)

- [MIT License](LICENSE-MIT)

[ci-cd-badge]: https://github.com/risoflora/lock_keys/actions/workflows/CI.yml/badge.svg

[ci-cd-url]: https://github.com/risoflora/lock_keys/actions/workflows/CI.yml

[crates-badge]: https://img.shields.io/crates/v/lock_keys.svg

[crates-url]: https://crates.io/crates/lock_keys

[docs-badge]: https://docs.rs/lock_keys/badge.svg

[docs-url]: https://docs.rs/lock_keys

[license-badge]: https://img.shields.io/crates/l/lock_keys.svg

[license-url]: https://github.com/risoflora/lock_keys#license

[xlib-wiki-url]: https://en.wikipedia.org/wiki/Xlib

[winuser-api-url]: https://docs.microsoft.com/en-us/windows/win32/api/winuser

[iokit-url]: https://developer.apple.com/documentation/iokit