1
Fork 0

Compare commits

..

6 Commits
1.0.0 ... main

Author SHA1 Message Date
Bauke e5713f5785
Move global lints to Cargo.toml. 2024-01-31 12:43:47 +01:00
Bauke 25bebee683
Update dependencies. 2024-01-31 12:42:31 +01:00
Bauke 8167f5b2fb
Remove infallible error. 2024-01-31 12:41:13 +01:00
Bauke e7a326c688
Add Nix flake and direnv files. 2024-01-31 12:39:56 +01:00
Bauke 64ee8db0be
Version 1.0.1! 2022-10-03 00:29:38 +02:00
Bauke 74b173f943
Update doc examples. 2022-10-03 00:29:27 +02:00
9 changed files with 207 additions and 46 deletions

3
.envrc Normal file
View File

@ -0,0 +1,3 @@
#!/usr/bin/env bash
use flake

8
.gitignore vendored
View File

@ -1,7 +1,5 @@
# Generated by Cargo .direnv/
Cargo.lock coverage/
debug/ debug/
target/ target/
Cargo.lock
# Code coverage results
coverage/

View File

@ -5,15 +5,22 @@ name = "webextension-native-messaging"
description = "WebExtension native messaging library for Rust." description = "WebExtension native messaging library for Rust."
repository = "https://git.bauke.xyz/Holllo/webextension-native-messaging" repository = "https://git.bauke.xyz/Holllo/webextension-native-messaging"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
version = "1.0.0" version = "1.0.1"
authors = ["Holllo <helllo@holllo.org>"] authors = ["Holllo <helllo@holllo.org>"]
edition = "2021" 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.145", features = ["derive"] } serde = { version = "1.0.196", features = ["derive"] }
serde_json = "1.0.85" serde_json = "1.0.113"
thiserror = "1.0.37" thiserror = "1.0.56"

View File

@ -1,33 +1,21 @@
[tasks.fmt] # Do a full check of everything.
command = "cargo"
args = ["fmt", "${@}"]
[tasks.check]
command = "cargo"
args = ["check", "${@}"]
[tasks.clippy]
command = "cargo"
args = ["clippy", "${@}"]
[tasks.test]
command = "cargo"
args = ["test", "${@}"]
[tasks.doc]
command = "cargo"
args = ["doc", "${@}"]
[tasks.build]
command = "cargo"
args = ["build", "${@}"]
[tasks.complete-check] [tasks.complete-check]
dependencies = ["fmt", "check", "clippy", "test", "doc", "build"] 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] [tasks.code-coverage]
workspace = false workspace = false
install_crate = "cargo-tarpaulin"
command = "cargo" command = "cargo"
args = [ args = [
"tarpaulin", "tarpaulin",
@ -35,5 +23,10 @@ args = [
"--out=html", "--out=html",
"--output-dir=coverage", "--output-dir=coverage",
"--skip-clean", "--skip-clean",
"--target-dir=target/tarpaulin" "--target-dir=target/tarpaulin",
] ]
# Do a source code spellcheck.
[tasks.spellcheck]
clear = true
command = "typos"

128
flake.lock Normal file
View File

@ -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
}

17
flake.nix Normal file
View File

@ -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; };
}
);
}

3
rustup-toolchain.toml Normal file
View File

@ -0,0 +1,3 @@
[toolchain]
channel = "stable"
components = ["cargo", "clippy", "rustfmt", "rust-src"]

18
shell.nix Normal file
View File

@ -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
];
}

View File

@ -1,6 +1,3 @@
#![forbid(unsafe_code)]
#![warn(missing_docs, clippy::missing_docs_in_private_items)]
//! # WebExtension Native Messaging //! # WebExtension Native Messaging
//! //!
//! > **WebExtension native messaging library for Rust.** //! > **WebExtension native messaging library for Rust.**
@ -18,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);
@ -39,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();
@ -57,9 +54,6 @@ 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),
@ -80,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)