From 3e5fca6ef413890272872e2d31376019b4d78d83 Mon Sep 17 00:00:00 2001 From: Toralf Wittner Date: Tue, 10 Sep 2024 21:32:17 +0200 Subject: [PATCH 1/6] Create dependabot.yml Signed-off-by: Toralf Wittner --- .github/dependabot.yml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..53f8242 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "cargo" + directory: "/" + schedule: + interval: "weekly" From bad753937d42f5032f3093b0fab50dff12bc37a1 Mon Sep 17 00:00:00 2001 From: Toralf Wittner Date: Tue, 10 Sep 2024 21:39:00 +0200 Subject: [PATCH 2/6] Create GitHub CI workflow. Signed-off-by: Toralf Wittner --- .github/workflows/develop.yml | 50 +++++++++++++++++++++++++++++++++++ .gitlab-ci.yml | 43 ------------------------------ 2 files changed, 50 insertions(+), 43 deletions(-) create mode 100644 .github/workflows/develop.yml delete mode 100644 .gitlab-ci.yml diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml new file mode 100644 index 0000000..fe0bd7c --- /dev/null +++ b/.github/workflows/develop.yml @@ -0,0 +1,50 @@ +name: Compile & Test + +on: [push, pull_request] + +env: + CARGO_TERM_COLOR: always + +jobs: + build_and_test: + runs-on: ubuntu-latest + strategy: + matrix: + toolchain: + - stable + - nightly + steps: + - uses: actions/checkout@v4 + - uses: Swatinem/rust-cache@v2 + + - id: restore-toolchain + uses: actions/cache/restore@v4 + with: + path: ~/.rustup + key: none + restore-keys: | + rust-${{ runner.os }}-${{ matrix.toolchain }} + + - id: toolchain + uses: dtolnay/rust-toolchain@stable + with: + toolchain: ${{ matrix.toolchain }} + components: clippy + + - name: Build + run: make build + + - name: Test + run: make test + + - name: Check + run: make check + + - name: Lint + run: cargo clippy --all-features --verbose + + - uses: actions/cache/save@v4 + if: ${{ ! endsWith(steps.restore-toolchain.outputs.cache-matched-key, steps.toolchain.outputs.cachekey) }} + with: + path: ~/.rustup + key: rust-${{ runner.os }}-${{ matrix.toolchain }}-${{ steps.toolchain.outputs.cachekey }} diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index 9c5da86..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,43 +0,0 @@ -stages: - - build - - test - - deploy - -build-stable: - stage: build - image: "rust:latest" - script: - - make build - -build-nightly: - stage: build - image: "rustlang/rust:nightly" - script: - - make build - -test-stable: - stage: test - image: "rust:latest" - script: - - make check - - make test - -test-nightly: - stage: test - image: "rustlang/rust:nightly" - script: - - make check - - make test - -pages: - stage: deploy - image: "rustlang/rust:nightly" - script: - - make doc - - mv target/doc public - artifacts: - paths: - - public - only: - - master - From aad5bd30be7213d4d5c44d983e33d2558aca684f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 11 Sep 2024 15:34:46 +0200 Subject: [PATCH 3/6] Update tokio-util requirement from 0.6 to 0.7 (#1) Updates the requirements on [tokio-util](https://github.com/tokio-rs/tokio) to permit the latest version. - [Release notes](https://github.com/tokio-rs/tokio/releases) - [Commits](https://github.com/tokio-rs/tokio/compare/tokio-util-0.6.0...tokio-util-0.7.12) --- updated-dependencies: - dependency-name: tokio-util dependency-type: direct:production ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- minicbor-io/Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/minicbor-io/Cargo.toml b/minicbor-io/Cargo.toml index 1026515..c6d35e7 100644 --- a/minicbor-io/Cargo.toml +++ b/minicbor-io/Cargo.toml @@ -28,4 +28,4 @@ minicbor-io = { path = ".", features = ["async-io"] } quickcheck = "1.0.1" rand = "0.8" tokio = { version = "1.0", features = ["macros", "net", "rt"] } -tokio-util = { version = "0.6", features = ["compat"] } +tokio-util = { version = "0.7", features = ["compat"] } From d4ce40ce0711cada375dafc36b40edbcb2263053 Mon Sep 17 00:00:00 2001 From: Toralf Wittner Date: Wed, 11 Sep 2024 16:03:07 +0200 Subject: [PATCH 4/6] Replace gitlab documentation links with docs.rs Signed-off-by: Toralf Wittner --- CHANGELOG.md | 4 ++-- README.md | 5 +---- minicbor-bench/Cargo.toml | 1 - minicbor-derive/Cargo.toml | 3 +-- minicbor-derive/README.md | 6 +----- minicbor-io/Cargo.toml | 3 +-- minicbor-io/README.md | 7 +------ minicbor-serde/Cargo.toml | 3 +-- minicbor-serde/README.md | 5 +---- minicbor-serde/src/lib.rs | 2 +- minicbor-tests/Cargo.toml | 1 - minicbor/Cargo.toml | 3 +-- minicbor/README.md | 6 +----- minicbor/src/lib.rs | 2 +- 14 files changed, 13 insertions(+), 38 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d0ad4f9..04c0533 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -616,6 +616,6 @@ - Initial release. -[1]: https://twittner.gitlab.io/minicbor/minicbor_derive/index.html#index_only +[1]: https://docs.rs/minicbor_derive/0.6.0/index.html#index_only [2]: https://www.rfc-editor.org/rfc/rfc8949.html#section-8 -[3]: https://twittner.gitlab.io/minicbor/minicbor/index.html#feature-flags +[3]: https://docs.rs/minicbor/0.10.0/index.html#feature-flags diff --git a/README.md b/README.md index f5eafe8..f5cfce4 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,7 @@ Integrates minicbor with serde. # Documentation -Documentation is available at - -- -- +Documentation is available at # License diff --git a/minicbor-bench/Cargo.toml b/minicbor-bench/Cargo.toml index d1b0d68..32c10be 100644 --- a/minicbor-bench/Cargo.toml +++ b/minicbor-bench/Cargo.toml @@ -6,7 +6,6 @@ authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" description = "minicbor benchmark suite" -repository = "https://gitlab.com/twittner/minicbor" [features] alloc = ["minicbor/alloc"] diff --git a/minicbor-derive/Cargo.toml b/minicbor-derive/Cargo.toml index 07b9a01..2e84c68 100644 --- a/minicbor-derive/Cargo.toml +++ b/minicbor-derive/Cargo.toml @@ -5,8 +5,7 @@ authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" description = "Derive minicbor `Decode` and `Encode` traits." -repository = "https://gitlab.com/twittner/minicbor" -documentation = "https://twittner.gitlab.io/minicbor/minicbor_derive/" +repository = "https://github.com/twittner/minicbor" keywords = ["cbor", "minicbor", "serialization", "encoding", "no_std"] categories = ["encoding"] diff --git a/minicbor-derive/README.md b/minicbor-derive/README.md index 1b94c5e..9ef02b4 100644 --- a/minicbor-derive/README.md +++ b/minicbor-derive/README.md @@ -5,10 +5,7 @@ and `minicbor::Decode` traits. # Documentation -Documentation is available at - -- -- +Documentation is available at # License @@ -18,4 +15,3 @@ CONTRIBUTING.md first. [1]: https://crates.io/crates/minicbor [2]: https://blueoakcouncil.org/license/1.0.0 - diff --git a/minicbor-io/Cargo.toml b/minicbor-io/Cargo.toml index c6d35e7..96fe0f3 100644 --- a/minicbor-io/Cargo.toml +++ b/minicbor-io/Cargo.toml @@ -5,8 +5,7 @@ authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" description = "A set of I/O utilities for minicbor." -repository = "https://gitlab.com/twittner/minicbor" -documentation = "https://twittner.gitlab.io/minicbor/minicbor_io/" +repository = "https://github.com/twittner/minicbor" keywords = ["cbor", "minicbor", "serialization", "encoding", "no_std"] categories = ["encoding"] diff --git a/minicbor-io/README.md b/minicbor-io/README.md index c2f7ce7..19be3d5 100644 --- a/minicbor-io/README.md +++ b/minicbor-io/README.md @@ -4,10 +4,7 @@ I/O utilities for reading and writing [`minicbor`][1]-encoded data. # Documentation -Documentation is available at - -- -- +Documentation is available at # License @@ -17,5 +14,3 @@ CONTRIBUTING.md first. [1]: https://crates.io/crates/minicbor [2]: https://blueoakcouncil.org/license/1.0.0 - - diff --git a/minicbor-serde/Cargo.toml b/minicbor-serde/Cargo.toml index 0118410..41c320d 100644 --- a/minicbor-serde/Cargo.toml +++ b/minicbor-serde/Cargo.toml @@ -5,8 +5,7 @@ authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" description = "Integrates minicbor with serde." -repository = "https://gitlab.com/twittner/minicbor" -documentation = "https://twittner.gitlab.io/minicbor/minicbor_serde/" +repository = "https://github.com/twittner/minicbor" keywords = ["cbor", "minicbor", "serde", "serialization", "no_std"] categories = ["encoding"] diff --git a/minicbor-serde/README.md b/minicbor-serde/README.md index 78e4cb2..4ff0c1e 100644 --- a/minicbor-serde/README.md +++ b/minicbor-serde/README.md @@ -4,10 +4,7 @@ Integrates [minicbor][1] with [serde][2]. # Documentation -Documentation is available at - -- -- +Documentation is available at # License diff --git a/minicbor-serde/src/lib.rs b/minicbor-serde/src/lib.rs index 4afe3c6..c31f065 100644 --- a/minicbor-serde/src/lib.rs +++ b/minicbor-serde/src/lib.rs @@ -36,7 +36,7 @@ //! ``` //! //! [serde]: https://serde.rs/ -//! [minicbor-derive]: https://twittner.gitlab.io/minicbor/minicbor_derive/ +//! [minicbor-derive]: https://docs.rs/minicbor_derive/ #[cfg(feature = "alloc")] extern crate alloc; diff --git a/minicbor-tests/Cargo.toml b/minicbor-tests/Cargo.toml index ddb7132..50e269a 100644 --- a/minicbor-tests/Cargo.toml +++ b/minicbor-tests/Cargo.toml @@ -6,7 +6,6 @@ authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" description = "minicbor test suite" -repository = "https://gitlab.com/twittner/minicbor" [features] alloc = ["minicbor/alloc"] diff --git a/minicbor/Cargo.toml b/minicbor/Cargo.toml index 10fbd90..7eb59fd 100644 --- a/minicbor/Cargo.toml +++ b/minicbor/Cargo.toml @@ -5,8 +5,7 @@ authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" description = "A small CBOR codec suitable for no_std environments." -repository = "https://gitlab.com/twittner/minicbor" -documentation = "https://twittner.gitlab.io/minicbor/minicbor/" +repository = "https://github.com/twittner/minicbor" keywords = ["cbor", "minicbor", "serialization", "encoding", "no_std"] categories = ["encoding"] build = "build.rs" diff --git a/minicbor/README.md b/minicbor/README.md index abaa0ec..4de57e1 100644 --- a/minicbor/README.md +++ b/minicbor/README.md @@ -4,10 +4,7 @@ A small [CBOR][1] codec suitable for `no_std` environments. # Documentation -Documentation is available at - -- -- +Documentation is available at # License @@ -17,4 +14,3 @@ CONTRIBUTING.md first. [1]: https://tools.ietf.org/html/rfc8949 [2]: https://blueoakcouncil.org/license/1.0.0 - diff --git a/minicbor/src/lib.rs b/minicbor/src/lib.rs index 5068ad6..608b4c6 100644 --- a/minicbor/src/lib.rs +++ b/minicbor/src/lib.rs @@ -29,7 +29,7 @@ //! //! Support for [serde][2] is available in [`minicbor-serde`][3]. //! -//! [1]: https://twittner.gitlab.io/minicbor/minicbor_io/ +//! [1]: https://docs.rs/minicbor_io/ //! [2]: https://crates.io/crates/serde //! [3]: https://crates.io/crates/minicbor-serde //! From 4cd6211eb05372bbd8ced45568e0f8cfb3b8d8a6 Mon Sep 17 00:00:00 2001 From: Toralf Wittner Date: Wed, 11 Sep 2024 16:18:32 +0200 Subject: [PATCH 5/6] Update CHANGELOG and increment versions. Signed-off-by: Toralf Wittner --- CHANGELOG.md | 16 ++++++++++++++++ minicbor-derive/Cargo.toml | 2 +- minicbor-io/Cargo.toml | 6 +++--- minicbor-serde/Cargo.toml | 4 ++-- minicbor/Cargo.toml | 2 +- 5 files changed, 23 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 04c0533..e707a5a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ # minicbor +## `0.25.1` + +- Update documentation. + ## `0.25.0` - Error types now implement `core::error::Error`, which was stabilised in Rust 1.81. @@ -345,6 +349,10 @@ # minicbor-derive +## `0.15.3` + +- Update documentation. + ## `0.15.2` - Maintenance release (documentation tweaks). @@ -467,6 +475,10 @@ # minicbor-io +## `0.20.1` + +- Update documentation. + ## `0.20.0` - Error types now implement `core::error::Error`, which was stabilised in Rust 1.81. @@ -597,6 +609,10 @@ # minicbor-serde +## `0.3.1` + +- Update documentation. + ## `0.3.0` - Error types now implement `core::error::Error`, which was stabilised in Rust 1.81. diff --git a/minicbor-derive/Cargo.toml b/minicbor-derive/Cargo.toml index 2e84c68..5239765 100644 --- a/minicbor-derive/Cargo.toml +++ b/minicbor-derive/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "minicbor-derive" -version = "0.15.2" +version = "0.15.3" authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" diff --git a/minicbor-io/Cargo.toml b/minicbor-io/Cargo.toml index 96fe0f3..291d199 100644 --- a/minicbor-io/Cargo.toml +++ b/minicbor-io/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "minicbor-io" -version = "0.20.0" +version = "0.20.1" authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" @@ -19,10 +19,10 @@ async-io = ["futures-core", "futures-io", "futures-util"] futures-core = { version = "0.3.8", optional = true } futures-io = { version = "0.3.8", optional = true } futures-util = { version = "0.3.8", features = ["io"], optional = true } -minicbor = { path = "../minicbor", version = "0.25.0", features = ["std"] } +minicbor = { path = "../minicbor", version = "0.25.1", features = ["std"] } [dev-dependencies] -minicbor = { path = "../minicbor", version = "0.25.0", features = ["std", "derive"] } +minicbor = { path = "../minicbor", version = "0.25.1", features = ["std", "derive"] } minicbor-io = { path = ".", features = ["async-io"] } quickcheck = "1.0.1" rand = "0.8" diff --git a/minicbor-serde/Cargo.toml b/minicbor-serde/Cargo.toml index 41c320d..c502d32 100644 --- a/minicbor-serde/Cargo.toml +++ b/minicbor-serde/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "minicbor-serde" -version = "0.3.0" +version = "0.3.1" authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" @@ -19,7 +19,7 @@ alloc = ["minicbor/alloc", "serde/alloc"] std = ["alloc", "minicbor/std", "serde/std"] [dependencies] -minicbor = { path = "../minicbor", version = "0.25.0" } +minicbor = { path = "../minicbor", version = "0.25.1" } half = { version = "2.4.0", default-features = false, optional = true } serde = { version = "1.0.197", default-features = false } diff --git a/minicbor/Cargo.toml b/minicbor/Cargo.toml index 7eb59fd..39f3a16 100644 --- a/minicbor/Cargo.toml +++ b/minicbor/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "minicbor" -version = "0.25.0" +version = "0.25.1" authors = ["Toralf Wittner "] license = "BlueOak-1.0.0" edition = "2021" From 1e111b51eed66adeba2f149d28b884552fe0a217 Mon Sep 17 00:00:00 2001 From: Toralf Wittner Date: Thu, 12 Sep 2024 11:53:31 +0200 Subject: [PATCH 6/6] Make issue and merge request links explicit. Signed-off-by: Toralf Wittner --- CHANGELOG.md | 107 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 73 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e707a5a..69bec11 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,7 +15,7 @@ - Error types now implement `core::error::Error`, which was stabilised in Rust 1.81. - `Encode` and `Decode` are implemented for `core::num::{NonZeroIsize, NonZeroUsize}` (see - merge request !48 by @chrysn). + merge request [48][mr48] by @chrysn). ## `0.24.4` @@ -23,15 +23,15 @@ ## `0.24.3` -- Maintenance release (cf. merge request !47 by @chrysn). +- Maintenance release (cf. merge request [47][mr47] by @chrysn). ## `0.24.2` -- Maintenance release (cf. merge request !46 by @deundiak). +- Maintenance release (cf. merge request [46][mr46] by @deundiak). ## `0.24.1` -- Maintenance release (cf. merge requests !44 by @alistair23 and !45 by @deundiak). +- Maintenance release (cf. merge requests [44][mr44] by @alistair23 and [45][mr45] by @deundiak). ## `0.24.0` @@ -48,34 +48,34 @@ - ⚠️ **Breaking** ⚠️: `Tokenizer` now has two lifetime parameters because it sometimes borrows the inner `Decoder`. -- `Token`s can now also be encoded (cf. merge request !37 by @alistair23). Methods `Encoder::tokens` +- `Token`s can now also be encoded (cf. merge request [37][mr37] by @alistair23). Methods `Encoder::tokens` and `Decoder::tokens` have been added. ## `0.21.1` -- `Tag::new` and `Tag::as_u64` are now declared `const` (cf. merge request !36 by @DCNick3). +- `Tag::new` and `Tag::as_u64` are now declared `const` (cf. merge request [36][mr36] by @DCNick3). ## `0.21.0` -- ⚠️ **Breaking** ⚠️: Tag handling has been reworked (cf. merge request !34). The `Tag` type is now +- ⚠️ **Breaking** ⚠️: Tag handling has been reworked (cf. merge request [34][mr34]). The `Tag` type is now merely a newtype around a `u64`. A new enum `IanaTag` represents registered tag values. ## `0.20.0` -- Support for decoding arrays of arbitrary length has been added (cf. merge request !31 by @samuelmhicks). -- Added `Encode` and `Decode` impls for `CStr` and `CString` (cf. merge request !29). -- Added `decode::info::Size` to allow length introspection of CBOR values (see merge requests !25 - and !28 for details). +- Support for decoding arrays of arbitrary length has been added (cf. merge request [31][mr31] by @samuelmhicks). +- Added `Encode` and `Decode` impls for `CStr` and `CString` (cf. merge request [29][mr29]). +- Added `decode::info::Size` to allow length introspection of CBOR values (see merge requests [25][mr25] + and [28][mr28] for details). ## `0.19.1` -- Bugfix release (see merge request !26 by @jeandudey for details). +- Bugfix release (see merge request [26][mr26] by @jeandudey for details). ## `0.19.0` - Added the trait `CborLen` and functions `minicbor::len` and `minicbor::len_with` to allow client - code to calculate the length in bytes of a value's CBOR representation. See issue #32 and merge - request !23 for details. + code to calculate the length in bytes of a value's CBOR representation. See issue [32][i32] and merge + request [23][mr23] for details. ## `0.18.0` @@ -111,7 +111,7 @@ - ⚠️ **Breaking** ⚠️: The `Encode` and `Decode` traits are now parameterised by a context type and the context value is passed as another argument to `Encode::encode` and `Decode::decode` (see - merge request !21 and issue #26 for details). + merge request [21][mr21] and issue [26][i26] for details). Implementations of these traits that do not make use of the context need to be generic in the type variable and accept the context parameter, e.g. instead of @@ -180,7 +180,7 @@ A new module `minicbor::legacy` is introduced which contains newtype wrappers for these types which continue to use the array-based encoding. Users can opt out of the new compact format by enabling the cargo feature `"legacy"` and importing the types from the legacy module. -- A new type `minicbor::data::Int` has been introduced (see merge request !20) to allow encoding +- A new type `minicbor::data::Int` has been introduced (see merge request [20][mr20]) to allow encoding and decoding of the whole CBOR integer range [-264, 264 - 1]. - ⚠️ **Breaking** ⚠️: As a consequence of adding the new `Int` type, a new constructor `minicbor::data::Type::Int` has been added to denote those (signed) integers that do not fit @@ -188,7 +188,7 @@ ## `0.14.2` -- Bugfix release: Imports `alloc::string::ToString` when necessary (see issue #21) for details. +- Bugfix release: Imports `alloc::string::ToString` when necessary (see issue [21][i21]) for details. ## `0.14.1` @@ -200,16 +200,16 @@ The actual error representation is hidden and errors are constructed with functions instead of creating enum values directly, for example `Error::Message("foo")` is now `Error::message("foo")`. This was done to support adding more information to error values, - like the decoding position. For details see merge request !19. + like the decoding position. For details see merge request [19][mr19]. ## `0.13.2` -- Added `Decode` impl for `Box` (see merge request !18 by @tailhook). +- Added `Decode` impl for `Box` (see merge request [18][mr18] by @tailhook). ## `0.13.1` - Bugfix: `Decoder::datatype` would sometimes report incorrect types for negative integers - (see issue #18 and commit 0bd97b72 for details). + (see issue [18][i18] and commit 0bd97b72 for details). ## `0.13.0` @@ -227,26 +227,26 @@ - Extend the optionality of fields beyond `Option`. This applies to derived impls of `Encode` and `Decode` which make use of newly added methods `Encode::is_nil` and `Decode::nil` - instead of `Option::is_none` and `None`. See issue #10 and merge request !15 for details. + instead of `Option::is_none` and `None`. See issue [10][i10] and merge request [15][mr15] for details. ## `0.11.5` -- Accept non-preferred integer encodings (see issue #14 for details). +- Accept non-preferred integer encodings (see issue [14][i14] for details). - Added `Decoder::{null, undefined}` methods. - Added `data::Cbor` as identity element of `Encode` and `Decode`. ## `0.11.4` - Bugfix: Decoding strings or bytes with a length of `u64::MAX` would cause an overflow of the - internal decoder position value. This case is now properly handled. See issue #12 for details. + internal decoder position value. This case is now properly handled. See issue [12][i12] for details. - Bugfix: The `partial-derive-support` feature did not re-export `minicbor-derive`, nor did it - make the functionality of `minicbor::bytes` available. See merge request !14 by @dne1 for details. + make the functionality of `minicbor::bytes` available. See merge request [14][mr14] by @dne1 for details. ## `0.11.3` - Bugfix release: Version `0.11.2` added `Encode`/`Decode` impls for various atomic types without - considering their availability on the target platform (cf. issue #11). In here we attempt to - only offer impls for available atomic types (cf. merge request !13 for details). + considering their availability on the target platform (cf. issue [11][i11]). In here we attempt to + only offer impls for available atomic types (cf. merge request [13][mr13] for details). ## `0.11.2` @@ -280,7 +280,7 @@ corresponds to the implementation of minicbor <= 0.9.1 but does not support skipping over indefinite-length arrays or maps inside of regular arrays or maps. The variant enabled by `"alloc"` supports skipping over arbitrary CBOR items. For more information see - [feature flags][3] and issue #9. + [feature flags][3] and issue [9][i9]. ## `0.9.1` @@ -290,12 +290,12 @@ - ⚠️ **Breaking** ⚠️: The encoding of `()` and `PhantomData` has changed. See commit b6b1f907. - ⚠️ **Breaking** ⚠️: The `decode::Error::TypeMismatch` constructor changed to use a `data::Type` - instead of a `u8` as its first parameter. See merge request !6 for details. + instead of a `u8` as its first parameter. See merge request [6][mr6] for details. - Added feature flag `alloc` (implied by `std`), which enables most collections types in a `no_std` - environment. See merge request !9 for details. + environment. See merge request [9][mr9] for details. - Added `ByteArray` to support compact encoding of `u8`-arrays, similarly to the already existing - `ByteSlice` and `ByteVec` types added in `minicbor-0.6.0`. See merge request !10 for details. -- Added `Write` impl for `alloc::vec::Vec` (see merge request !11 by @Hawk777). + `ByteSlice` and `ByteVec` types added in `minicbor-0.6.0`. See merge request [10][mr10] for details. +- Added `Write` impl for `alloc::vec::Vec` (see merge request [11][mr11] by @Hawk777). - Depends on `minicbor-derive-0.6.4`. ## `0.8.1` @@ -325,7 +325,7 @@ ## `0.6.0` -- Removes the `&[u8]` impl for `Decode` (see issue #4) and add a new module `minicbor::bytes` +- Removes the `&[u8]` impl for `Decode` (see issue [4][i4]) and add a new module `minicbor::bytes` to support specialised encoding of CBOR bytes. This module provides the types `ByteSlice` and `ByteVec` which are substitutes for `&[u8]` and `Vec` respectively. See also the module documentation of `minicbor::bytes`. @@ -345,7 +345,7 @@ ## `0.4.0` -- Added `Encode` and `Decode` impls for tuples (see merge request !1 by @koushiro). +- Added `Encode` and `Decode` impls for tuples (see merge request [1][mr1] by @koushiro). # minicbor-derive @@ -434,7 +434,7 @@ ## `0.6.4` -- Improve hygiene (see merge request !7). +- Improve hygiene (see merge request [7][mr7]). ## `0.6.3` @@ -635,3 +635,42 @@ [1]: https://docs.rs/minicbor_derive/0.6.0/index.html#index_only [2]: https://www.rfc-editor.org/rfc/rfc8949.html#section-8 [3]: https://docs.rs/minicbor/0.10.0/index.html#feature-flags + +[mr1]: https://gitlab.com/twittner/minicbor/-/merge_requests/1 +[mr6]: https://gitlab.com/twittner/minicbor/-/merge_requests/6 +[mr7]: https://gitlab.com/twittner/minicbor/-/merge_requests/7 +[mr9]: https://gitlab.com/twittner/minicbor/-/merge_requests/9 +[mr10]: https://gitlab.com/twittner/minicbor/-/merge_requests/10 +[mr11]: https://gitlab.com/twittner/minicbor/-/merge_requests/11 +[mr13]: https://gitlab.com/twittner/minicbor/-/merge_requests/13 +[mr14]: https://gitlab.com/twittner/minicbor/-/merge_requests/14 +[mr15]: https://gitlab.com/twittner/minicbor/-/merge_requests/15 +[mr18]: https://gitlab.com/twittner/minicbor/-/merge_requests/18 +[mr19]: https://gitlab.com/twittner/minicbor/-/merge_requests/19 +[mr20]: https://gitlab.com/twittner/minicbor/-/merge_requests/20 +[mr21]: https://gitlab.com/twittner/minicbor/-/merge_requests/21 +[mr23]: https://gitlab.com/twittner/minicbor/-/merge_requests/23 +[mr25]: https://gitlab.com/twittner/minicbor/-/merge_requests/25 +[mr26]: https://gitlab.com/twittner/minicbor/-/merge_requests/26 +[mr28]: https://gitlab.com/twittner/minicbor/-/merge_requests/28 +[mr29]: https://gitlab.com/twittner/minicbor/-/merge_requests/29 +[mr31]: https://gitlab.com/twittner/minicbor/-/merge_requests/31 +[mr34]: https://gitlab.com/twittner/minicbor/-/merge_requests/34 +[mr36]: https://gitlab.com/twittner/minicbor/-/merge_requests/36 +[mr37]: https://gitlab.com/twittner/minicbor/-/merge_requests/37 +[mr44]: https://gitlab.com/twittner/minicbor/-/merge_requests/44 +[mr45]: https://gitlab.com/twittner/minicbor/-/merge_requests/45 +[mr46]: https://gitlab.com/twittner/minicbor/-/merge_requests/46 +[mr47]: https://gitlab.com/twittner/minicbor/-/merge_requests/47 +[mr48]: https://gitlab.com/twittner/minicbor/-/merge_requests/48 + +[i4]: https://gitlab.com/twittner/minicbor/-/issues/4 +[i9]: https://gitlab.com/twittner/minicbor/-/issues/9 +[i10]: https://gitlab.com/twittner/minicbor/-/issues/10 +[i11]: https://gitlab.com/twittner/minicbor/-/issues/11 +[i12]: https://gitlab.com/twittner/minicbor/-/issues/12 +[i14]: https://gitlab.com/twittner/minicbor/-/issues/14 +[i18]: https://gitlab.com/twittner/minicbor/-/issues/18 +[i21]: https://gitlab.com/twittner/minicbor/-/issues/21 +[i26]: https://gitlab.com/twittner/minicbor/-/issues/26 +[i32]: https://gitlab.com/twittner/minicbor/-/issues/32