mirror of
https://github.com/nushell/nushell.git
synced 2024-11-25 18:03:51 +01:00
712fec166d
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> I was working with byte collections like `Vec<u8>` and [`bytes::Bytes`](https://docs.rs/bytes/1.7.1/bytes/struct.Bytes.html), both are currently not possible to be used directly in a struct that derives `IntoValue` and `FromValue` at the same time. The `Vec<u8>` will convert itself into a `Value::List` but expects a `Value::String` or `Value::Binary` to load from. I now also implemented that it can load from `Value::List` just like the other `Vec<uX>` versions. For further working with byte collections the type `bytes::Bytes` is wildly used, therefore I added a implementation for it. `bytes` is already part of the dependency graph as many crates (more than 5000 to crates.io) use it. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> User of `nu-protocol` as library, e.g. plugin developers, can now use byte collections more easily in their data structures and derive `IntoValue` and `FromValue` for it. # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> I added a few tests that check that these byte collections are correctly translated in and from `Value`. They live in `test_derive.rs` as part of the `ByteContainer` and I also explicitely tested that `FromValue` for `Vec<u8>` works as expected. - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --> Maybe it should be explored if `Value::Binary` should use `bytes::Bytes` instead of `Vec<u8>`.
64 lines
2.0 KiB
TOML
64 lines
2.0 KiB
TOML
[package]
|
|
authors = ["The Nushell Project Developers"]
|
|
description = "Nushell's internal protocols, including its abstract syntax tree"
|
|
repository = "https://github.com/nushell/nushell/tree/main/crates/nu-protocol"
|
|
edition = "2021"
|
|
license = "MIT"
|
|
name = "nu-protocol"
|
|
version = "0.97.2"
|
|
|
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
|
|
[lib]
|
|
bench = false
|
|
|
|
[dependencies]
|
|
nu-utils = { path = "../nu-utils", version = "0.97.2" }
|
|
nu-path = { path = "../nu-path", version = "0.97.2" }
|
|
nu-system = { path = "../nu-system", version = "0.97.2" }
|
|
nu-derive-value = { path = "../nu-derive-value", version = "0.97.2" }
|
|
|
|
brotli = { workspace = true, optional = true }
|
|
bytes = { workspace = true }
|
|
byte-unit = { version = "5.1", features = [ "serde" ] }
|
|
chrono = { workspace = true, features = [ "serde", "std", "unstable-locales" ], default-features = false }
|
|
chrono-humanize = { workspace = true }
|
|
convert_case = { workspace = true }
|
|
dirs = { workspace = true }
|
|
fancy-regex = { workspace = true }
|
|
indexmap = { workspace = true }
|
|
lru = { workspace = true }
|
|
miette = { workspace = true, features = ["fancy-no-backtrace"] }
|
|
num-format = { workspace = true }
|
|
rmp-serde = { workspace = true, optional = true }
|
|
serde = { workspace = true, default-features = false }
|
|
thiserror = "1.0"
|
|
typetag = "0.2"
|
|
os_pipe = { workspace = true, features = ["io_safety"] }
|
|
log = { workspace = true }
|
|
|
|
[target.'cfg(unix)'.dependencies]
|
|
nix = { workspace = true, default-features = false, features = ["signal"] }
|
|
|
|
[target.'cfg(windows)'.dependencies]
|
|
dirs-sys = { workspace = true }
|
|
windows-sys = { workspace = true }
|
|
|
|
[features]
|
|
plugin = [
|
|
"brotli",
|
|
"rmp-serde",
|
|
]
|
|
|
|
[dev-dependencies]
|
|
serde_json = { workspace = true }
|
|
strum = "0.26"
|
|
strum_macros = "0.26"
|
|
nu-test-support = { path = "../nu-test-support", version = "0.97.2" }
|
|
pretty_assertions = { workspace = true }
|
|
rstest = { workspace = true }
|
|
tempfile = { workspace = true }
|
|
os_pipe = { workspace = true }
|
|
|
|
[package.metadata.docs.rs]
|
|
all-features = true |