Use stable internals for key-value API #550

KodrAus · 2023-04-10T08:01:33Z

There are two (formally) unstable libraries that we depend on in the key-value API:

value-bag: is the backing structure for Value that lets us capture and erase value types. We don't want to publicly expose it.
sval: is an alternative serialisation framework to serde with an alloc-free object-safe API. It's an optional public dependency, like serde.

Both of these libraries now have stable releases so this PR moves to them. This was one of the blockers to stabilising the key-value API in #436. It's also a good excuse to get another release of log out, since we haven't made one in a while.

KodrAus · 2023-04-10T08:02:07Z

Cargo.toml

 kv_unstable_std = ["std", "kv_unstable", "value-bag/error"]
 kv_unstable_serde = ["kv_unstable_std", "value-bag/serde", "serde"]

 [dependencies]
 serde = { version = "1.0", optional = true, default-features = false }
-sval = { version = "=1.0.0-alpha.5", optional = true, default-features = false }
-value-bag = { version = "=1.0.0-alpha.9", optional = true, default-features = false }
+sval = { version = "2.1", optional = true, default-features = false }


I ended up skipping a stable 1.x for this library in the end, because the API changed fairly significantly between beta releases.

KodrAus · 2023-04-10T08:02:42Z

src/kv/key.rs

@@ -48,6 +48,12 @@ impl<'k> Key<'k> {
    pub fn as_str(&self) -> &str {
        self.key
    }
+
+    /// Try get a string borrowed for the `'k` lifetime from this key.
+    pub fn to_borrowed_str(&self) -> Option<&'k str> {


This returns an Option even though it's currently always Some so that we've got room to make the internals something like a Cow<'k, str>.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [log](https://github.com/rust-lang/log) | dependencies | patch | `0.4.17` -> `0.4.19` | --- ### Release Notes <details> <summary>rust-lang/log</summary> ### [`v0.4.19`](https://github.com/rust-lang/log/blob/HEAD/CHANGELOG.md#0419---2023-06-10) [Compare Source](rust-lang/log@0.4.18...0.4.19) - Use target_has_atomic instead of the old atomic_cas cfg by [@GuillaumeGomez](https://github.com/GuillaumeGomez) in rust-lang/log#555 - Put MSRV into Cargo.toml by [@est31](https://github.com/est31) in rust-lang/log#557 ### [`v0.4.18`](https://github.com/rust-lang/log/blob/HEAD/CHANGELOG.md#0418---2023-05-28) [Compare Source](rust-lang/log@0.4.17...0.4.18) - fix markdown links (again) by [@hellow554](https://github.com/hellow554) in rust-lang/log#513 - add cargo doc to workflow by [@hellow554](https://github.com/hellow554) in rust-lang/log#515 - Apply Clippy lints by [@hellow554](https://github.com/hellow554) in rust-lang/log#516 - Replace ad-hoc eq_ignore_ascii_case with slice::eq_ignore_ascii_case by [@glandium](https://github.com/glandium) in rust-lang/log#519 - fix up windows targets by [@KodrAus](https://github.com/KodrAus) in rust-lang/log#528 - typo fix by [@jiangying000](https://github.com/jiangying000) in rust-lang/log#529 - Remove dependency on cfg_if by [@EriKWDev](https://github.com/EriKWDev) in rust-lang/log#536 - GitHub Workflows security hardening by [@sashashura](https://github.com/sashashura) in rust-lang/log#538 - Fix build status badge by [@atouchet](https://github.com/atouchet) in rust-lang/log#539 - Add call_logger to the documentation by [@a1ecbr0wn](https://github.com/a1ecbr0wn) in rust-lang/log#547 - Use stable internals for key-value API by [@KodrAus](https://github.com/KodrAus) in rust-lang/log#550 - Change wording of list of implementations by [@Thomasdezeeuw](https://github.com/Thomasdezeeuw) in rust-lang/log#553 - Add std-logger to list of implementations by [@Thomasdezeeuw](https://github.com/Thomasdezeeuw) in rust-lang/log#554 - Add `set_max_level_racy` and gate `set_max_level` by [@djkoloski](https://github.com/djkoloski) in rust-lang/log#544 - \[doc] src/lib.rs : prefix an unused variable with an underscore by [@OccupyMars2025](https://github.com/OccupyMars2025) in rust-lang/log#561 - \[doc] src/macros.rs : correct grammar errors of an example in lib documentation by [@OccupyMars2025](https://github.com/OccupyMars2025) in rust-lang/log#562 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <[email protected]> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1911 Reviewed-by: crapStone <[email protected]> Co-authored-by: Calciumdibromid Bot <[email protected]> Co-committed-by: Calciumdibromid Bot <[email protected]>

KodrAus added 4 commits April 9, 2023 16:53

port to stable versions of value-bag and sval

c644e6f

borrow for 'kv from Key<'kv> and Value<'kv>

9c125f2

qualify path to serde

955d352

fix up path in doc comments

b71d3b1

KodrAus force-pushed the feat/stable-kv-internals branch from 18a8584 to b71d3b1 Compare April 10, 2023 08:06

KodrAus commented Apr 10, 2023

View reviewed changes

KodrAus added 2 commits April 10, 2023 18:08

run fmt

ab829c6

only run tests on MSRV

8311727

Thomasdezeeuw approved these changes Apr 10, 2023

View reviewed changes

KodrAus mentioned this pull request Apr 10, 2023

Add the structured-logger crate to the README #548

Merged

Merge branch 'master' into feat/stable-kv-internals

ef94087

KodrAus merged commit 5434ebe into master Apr 10, 2023

KodrAus mentioned this pull request Apr 11, 2023

Prepare for 0.4.19 release #552

Merged

KodrAus deleted the feat/stable-kv-internals branch April 13, 2023 03:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use stable internals for key-value API #550

Use stable internals for key-value API #550

KodrAus commented Apr 10, 2023

KodrAus Apr 10, 2023

KodrAus Apr 10, 2023

Use stable internals for key-value API #550

Use stable internals for key-value API #550

Conversation

KodrAus commented Apr 10, 2023

KodrAus Apr 10, 2023

Choose a reason for hiding this comment

KodrAus Apr 10, 2023

Choose a reason for hiding this comment