Compare commits
12 Commits
Author | SHA1 | Date |
---|---|---|
Bauke | e5713f5785 | |
Bauke | 25bebee683 | |
Bauke | 8167f5b2fb | |
Bauke | e7a326c688 | |
Bauke | 64ee8db0be | |
Bauke | 74b173f943 | |
Bauke | e732623802 | |
Bauke | 7623cb6b3e | |
Bauke | c4f8feab8b | |
Bauke | ed52651e7f | |
Bauke | f4b1b240a7 | |
Bauke | ca447df525 |
|
@ -1,10 +1,5 @@
|
||||||
# Generated by Cargo
|
.direnv/
|
||||||
# will have compiled files and executables
|
coverage/
|
||||||
/target/
|
debug/
|
||||||
|
target/
|
||||||
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
|
|
||||||
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
|
|
||||||
Cargo.lock
|
Cargo.lock
|
||||||
|
|
||||||
# These are backup files generated by rustfmt
|
|
||||||
**/*.rs.bk
|
|
||||||
|
|
27
Cargo.toml
27
Cargo.toml
|
@ -1,19 +1,26 @@
|
||||||
# https://doc.rust-lang.org/cargo/reference/manifest.html
|
# https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[package]
|
[package]
|
||||||
name = "web-ext-native-messaging"
|
name = "webextension-native-messaging"
|
||||||
description = "WebExtension native messaging with serde_json as the (de)serializer."
|
description = "WebExtension native messaging library for Rust."
|
||||||
version = "0.1.0"
|
repository = "https://git.bauke.xyz/Holllo/webextension-native-messaging"
|
||||||
authors = ["Holllo <helllo@holllo.cc>"]
|
|
||||||
license = "MIT OR Apache-2.0"
|
license = "MIT OR Apache-2.0"
|
||||||
repository = "https://github.com/Holllo/web-ext-native-messaging"
|
version = "1.0.1"
|
||||||
edition = "2018"
|
authors = ["Holllo <helllo@holllo.org>"]
|
||||||
|
edition = "2021"
|
||||||
|
|
||||||
[lib]
|
[lib]
|
||||||
path = "source/lib.rs"
|
path = "source/lib.rs"
|
||||||
|
|
||||||
|
[lints.clippy]
|
||||||
|
missing_docs_in_private_items = "warn"
|
||||||
|
|
||||||
|
[lints.rust]
|
||||||
|
missing_docs = "warn"
|
||||||
|
unsafe_code = "forbid"
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
byteorder = "1.4.3"
|
byteorder = "1.5.0"
|
||||||
serde = { version = "1.0", features = ["derive"] }
|
serde = { version = "1.0.196", features = ["derive"] }
|
||||||
serde_json = "1.0"
|
serde_json = "1.0.113"
|
||||||
thiserror = "1.0"
|
thiserror = "1.0.56"
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2021 Holllo <helllo@holllo.cc>
|
Copyright (c) 2021-2022 Holllo <helllo@holllo.org>
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
|
@ -0,0 +1,32 @@
|
||||||
|
# Do a full check of everything.
|
||||||
|
[tasks.complete-check]
|
||||||
|
dependencies = [
|
||||||
|
"format",
|
||||||
|
"spellcheck",
|
||||||
|
"check",
|
||||||
|
"clippy",
|
||||||
|
"test",
|
||||||
|
"code-coverage",
|
||||||
|
"docs",
|
||||||
|
"build",
|
||||||
|
"audit-flow",
|
||||||
|
"outdated-flow",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Run cargo-tarpaulin and output the test coverage.
|
||||||
|
[tasks.code-coverage]
|
||||||
|
workspace = false
|
||||||
|
command = "cargo"
|
||||||
|
args = [
|
||||||
|
"tarpaulin",
|
||||||
|
"--exclude-files=target/*",
|
||||||
|
"--out=html",
|
||||||
|
"--output-dir=coverage",
|
||||||
|
"--skip-clean",
|
||||||
|
"--target-dir=target/tarpaulin",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Do a source code spellcheck.
|
||||||
|
[tasks.spellcheck]
|
||||||
|
clear = true
|
||||||
|
command = "typos"
|
21
README.md
21
README.md
|
@ -1,22 +1,11 @@
|
||||||
# web-ext-native-messaging
|
# WebExtension 🛰 Native Messaging
|
||||||
|
|
||||||
WebExtension native messaging with serde_json as the (de)serializer.
|
> **WebExtension native messaging library for Rust.**
|
||||||
|
|
||||||
## Documentation
|
## Usage
|
||||||
|
|
||||||
See [docs.rs](https://docs.rs/web-ext-native-messaging) for documentation.
|
For documentation and examples see [docs.rs](https://docs.rs/webextension-native-messaging).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Licensed under either of
|
Distributed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html) and [MIT](https://spdx.org/licenses/MIT.html) licenses, see [LICENSE-Apache](https://git.bauke.xyz/Holllo/webextension-native-messaging/src/branch/main/LICENSE-Apache) and [LICENSE-MIT](https://git.bauke.xyz/Holllo/webextension-native-messaging/src/branch/main/LICENSE-MIT) for more information.
|
||||||
|
|
||||||
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
|
|
||||||
- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
|
|
||||||
|
|
||||||
at your option.
|
|
||||||
|
|
||||||
#### Contribution
|
|
||||||
|
|
||||||
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
||||||
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
|
|
||||||
dual licensed as above, without any additional terms or conditions.
|
|
||||||
|
|
|
@ -0,0 +1,128 @@
|
||||||
|
{
|
||||||
|
"nodes": {
|
||||||
|
"flake-utils": {
|
||||||
|
"inputs": {
|
||||||
|
"systems": "systems"
|
||||||
|
},
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1705309234,
|
||||||
|
"narHash": "sha256-uNRRNRKmJyCRC/8y1RqBkqWBLM034y4qN7EprSdmgyA=",
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"rev": "1ef2e671c3b0c19053962c07dbda38332dcebf26",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"flake-utils_2": {
|
||||||
|
"inputs": {
|
||||||
|
"systems": "systems_2"
|
||||||
|
},
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1705309234,
|
||||||
|
"narHash": "sha256-uNRRNRKmJyCRC/8y1RqBkqWBLM034y4qN7EprSdmgyA=",
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"rev": "1ef2e671c3b0c19053962c07dbda38332dcebf26",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"nixpkgs": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1706589919,
|
||||||
|
"narHash": "sha256-pNHnDITxSI3a17GOF1RUF3jBO1OiNYTRH2yV/cJG4m4=",
|
||||||
|
"owner": "NixOS",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "222c1940fafeda4dea161858ffe6ebfc853d3db5",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"id": "nixpkgs",
|
||||||
|
"type": "indirect"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"nixpkgs_2": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1706487304,
|
||||||
|
"narHash": "sha256-LE8lVX28MV2jWJsidW13D2qrHU/RUUONendL2Q/WlJg=",
|
||||||
|
"owner": "NixOS",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "90f456026d284c22b3e3497be980b2e47d0b28ac",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "NixOS",
|
||||||
|
"ref": "nixpkgs-unstable",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": {
|
||||||
|
"inputs": {
|
||||||
|
"flake-utils": "flake-utils",
|
||||||
|
"nixpkgs": "nixpkgs",
|
||||||
|
"rust-overlay": "rust-overlay"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rust-overlay": {
|
||||||
|
"inputs": {
|
||||||
|
"flake-utils": "flake-utils_2",
|
||||||
|
"nixpkgs": "nixpkgs_2"
|
||||||
|
},
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1706667075,
|
||||||
|
"narHash": "sha256-KBI5jcOWh9nsOFWj2SRq7vj+fPDf8Do8ceL582kFA70=",
|
||||||
|
"owner": "oxalica",
|
||||||
|
"repo": "rust-overlay",
|
||||||
|
"rev": "2c993daf3136c6955fd13bfe215d0d4faf6090f1",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "oxalica",
|
||||||
|
"repo": "rust-overlay",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"systems": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1681028828,
|
||||||
|
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
|
||||||
|
"owner": "nix-systems",
|
||||||
|
"repo": "default",
|
||||||
|
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "nix-systems",
|
||||||
|
"repo": "default",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"systems_2": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1681028828,
|
||||||
|
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
|
||||||
|
"owner": "nix-systems",
|
||||||
|
"repo": "default",
|
||||||
|
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "nix-systems",
|
||||||
|
"repo": "default",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": "root",
|
||||||
|
"version": 7
|
||||||
|
}
|
|
@ -0,0 +1,17 @@
|
||||||
|
{
|
||||||
|
inputs = {
|
||||||
|
flake-utils.url = "github:numtide/flake-utils";
|
||||||
|
rust-overlay.url = "github:oxalica/rust-overlay";
|
||||||
|
};
|
||||||
|
|
||||||
|
outputs = { self, nixpkgs, flake-utils, rust-overlay }:
|
||||||
|
flake-utils.lib.eachDefaultSystem (system:
|
||||||
|
let
|
||||||
|
overlays = [ (import rust-overlay) ];
|
||||||
|
pkgs = import nixpkgs { inherit system overlays; };
|
||||||
|
in
|
||||||
|
{
|
||||||
|
devShells.default = import ./shell.nix { inherit pkgs; };
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
|
@ -0,0 +1,3 @@
|
||||||
|
[toolchain]
|
||||||
|
channel = "stable"
|
||||||
|
components = ["cargo", "clippy", "rustfmt", "rust-src"]
|
|
@ -0,0 +1,18 @@
|
||||||
|
{ pkgs ? import <nixpkgs> { } }:
|
||||||
|
|
||||||
|
with pkgs;
|
||||||
|
|
||||||
|
let
|
||||||
|
rustup-toolchain = rust-bin.fromRustupToolchainFile ./rustup-toolchain.toml;
|
||||||
|
in
|
||||||
|
mkShell rec {
|
||||||
|
packages = [
|
||||||
|
cargo-audit
|
||||||
|
cargo-edit
|
||||||
|
cargo-make
|
||||||
|
cargo-outdated
|
||||||
|
cargo-tarpaulin
|
||||||
|
rustup-toolchain
|
||||||
|
typos
|
||||||
|
];
|
||||||
|
}
|
|
@ -1,11 +1,6 @@
|
||||||
#![forbid(unsafe_code)]
|
//! # WebExtension Native Messaging
|
||||||
#![warn(missing_docs, clippy::missing_docs_in_private_items)]
|
|
||||||
|
|
||||||
//! # web-ext-native-messaging
|
|
||||||
//!
|
//!
|
||||||
//! WebExtension [native messaging] with [`serde_json`] as the (de)serializer.
|
//! > **WebExtension native messaging library for Rust.**
|
||||||
//!
|
|
||||||
//! [native messaging]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging#app_side
|
|
||||||
//!
|
//!
|
||||||
//! ## Reading
|
//! ## Reading
|
||||||
//!
|
//!
|
||||||
|
@ -20,7 +15,7 @@
|
||||||
//! Then in your native executable:
|
//! Then in your native executable:
|
||||||
//!
|
//!
|
||||||
//! ```rust,no_run
|
//! ```rust,no_run
|
||||||
//! use web_ext_native_messaging::read_message;
|
//! use webextension_native_messaging::read_message;
|
||||||
//!
|
//!
|
||||||
//! let message = read_message::<String>().unwrap();
|
//! let message = read_message::<String>().unwrap();
|
||||||
//! println!("{}", message);
|
//! println!("{}", message);
|
||||||
|
@ -41,7 +36,7 @@
|
||||||
//! Then in your native executable:
|
//! Then in your native executable:
|
||||||
//!
|
//!
|
||||||
//! ```rust,no_run
|
//! ```rust,no_run
|
||||||
//! use web_ext_native_messaging::write_message;
|
//! use webextension_native_messaging::write_message;
|
||||||
//!
|
//!
|
||||||
//! let message = "Hey, there!".to_string();
|
//! let message = "Hey, there!".to_string();
|
||||||
//! write_message(&message).unwrap();
|
//! write_message(&message).unwrap();
|
||||||
|
@ -52,19 +47,13 @@
|
||||||
//!
|
//!
|
||||||
//! [native messaging documentation]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging
|
//! [native messaging documentation]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging
|
||||||
|
|
||||||
use std::{
|
use std::io::{Read, Write};
|
||||||
convert::TryInto,
|
|
||||||
io::{Read, Write},
|
|
||||||
};
|
|
||||||
|
|
||||||
use byteorder::{NativeEndian, ReadBytesExt, WriteBytesExt};
|
use byteorder::{NativeEndian, ReadBytesExt, WriteBytesExt};
|
||||||
|
|
||||||
/// All possible errors that can happen with reading or writing messages.
|
/// All possible errors that can happen with reading or writing messages.
|
||||||
#[derive(Debug, thiserror::Error)]
|
#[derive(Debug, thiserror::Error)]
|
||||||
pub enum MessagingError {
|
pub enum MessagingError {
|
||||||
/// Infallible errors.
|
|
||||||
#[error(transparent)]
|
|
||||||
Infallible(#[from] std::convert::Infallible),
|
|
||||||
#[error(transparent)]
|
#[error(transparent)]
|
||||||
/// IO errors.
|
/// IO errors.
|
||||||
Io(#[from] std::io::Error),
|
Io(#[from] std::io::Error),
|
||||||
|
@ -85,7 +74,7 @@ where
|
||||||
D: for<'a> serde::Deserialize<'a>,
|
D: for<'a> serde::Deserialize<'a>,
|
||||||
R: Read,
|
R: Read,
|
||||||
{
|
{
|
||||||
let message_length = reader.read_u32::<NativeEndian>()?.try_into()?;
|
let message_length = reader.read_u32::<NativeEndian>()?.into();
|
||||||
let message_bytes = reader.take(message_length);
|
let message_bytes = reader.take(message_length);
|
||||||
|
|
||||||
serde_json::from_reader(message_bytes).map_err(Into::into)
|
serde_json::from_reader(message_bytes).map_err(Into::into)
|
||||||
|
|
Loading…
Reference in New Issue