v6.0.0

Breaking Changes

• MSRV increased to Rust 1.83.0
• The std feature is removed. All errors in boba implement core::error::Error.

What's Changed

• Regenerate benchmarks/.gitignore by @lopopolo in #162
• Update fuzz workspace .gitignore to latest cargo-fuzz template by @lopopolo in #163
• Regenerate .gitignore by @lopopolo in #164
• Ensure MSRV CI job overrides the active Rust version by @lopopolo in #165
• chore: Update .github/workflows/code-coverage.yaml in artichoke/boba by @lopopolo in #166
• Move readme doctest module at the end of the file by @lopopolo in #168
• chore: Update .github/workflows/code-coverage.yaml in artichoke/boba by @lopopolo in #169
• chore: Update .github/workflows/code-coverage.yaml in artichoke/boba by @lopopolo in #170
• Fix glob to allow vendor/README.md to be linted for markdown links by @lopopolo in #171
• Bump rubocop from 1.32.0 to 1.36.0 by @dependabot in #173
• chore: Update .github/workflows/audit.yaml in artichoke/boba by @lopopolo in #175
• Add cargo-spellcheck dictionary and fix typos by @lopopolo in #176
• chore(deps): Bump actions/checkout from 2 to 3 by @dependabot in #178
• Update criterion on benchmarks to 0.4.0 by @lopopolo in #179
• chore(deps): Bump rubocop from 1.36.0 to 1.38.0 by @dependabot in #180
• chore: Update .github/workflows/rustdoc.yaml in artichoke/boba by @lopopolo in #182
• Remove actions-rs GitHub Actions by @lopopolo in #181
• chore(deps): Bump rubocop from 1.38.0 to 1.39.0 by @dependabot in #183
• Set rust-version in Cargo.toml to 1.42.0 by @lopopolo in #184
• chore: Update .github/workflows/audit.yaml in artichoke/boba by @lopopolo in #185
• chore: Update .github/workflows/code-coverage.yaml in artichoke/boba by @lopopolo in #186
• chore: Update .github/workflows/code-coverage.yaml in artichoke/boba by @lopopolo in #187
• chore(deps): Bump mheap/github-action-required-labels from 2 to 3 by @dependabot in #189
• chore(deps): Bump rubocop from 1.39.0 to 1.42.0 by @dependabot in #188
• chore(deps): Bump rubocop from 1.42.0 to 1.44.1 by @dependabot in #190
• chore(deps): Bump rubocop from 1.44.1 to 1.47.0 by @dependabot in #191
• chore(deps): Bump rubocop from 1.47.0 to 1.48.1 by @dependabot in #192
• chore: Update .github/workflows/rustdoc.yaml in artichoke/boba by @lopopolo in #193
• Upgrade Ruby version and bundler version by @lopopolo in #194
• Use stricter version pinning for GitHub Actions by @lopopolo in #195
• chore(deps): Bump ruby/setup-ruby from 1.147.0 to 1.148.0 by @dependabot in #197
• chore(deps): Bump rubocop from 1.48.1 to 1.50.2 by @dependabot in #196
• Stop monitoring Twitter links, fix markdown link check job by @lopopolo in #198
• chore: Update .github/workflows/code-coverage.yaml in artichoke/boba by @lopopolo in #199
• Add a test that exercises the letter 'c' in the alphabet by @lopopolo in #200
• Add code coverage badge to README by @lopopolo in #201
• chore(deps): Bump ruby/setup-ruby from 1.148.0 to 1.150.0 by @dependabot in #205
• chore(deps): Bump aws-actions/configure-aws-credentials from 2.0.0 to 2.1.0 by @dependabot in #204
• chore(deps): Bump rubocop from 1.50.2 to 1.51.0 by @dependabot in #202
• chore(deps): Update criterion requirement from 0.4.0 to 0.5.1 in /benchmarks by @dependabot in #203
• Remove criterion benchmarks workspace by @lopopolo in #206
• chore(deps): Bump rubocop from 1.51.0 to 1.54.0 by @dependabot in #211
• chore(deps): Bump ruby/setup-ruby from 1.150.0 to 1.152.0 by @dependabot in #210
• chore(deps): Bump actions/checkout from 3.5.2 to 3.5.3 by @dependabot in #209
• chore(deps): Bump aws-actions/configure-aws-credentials from 2.1.0 to 2.2.0 by @dependabot in #208
• chore(deps): Bump mheap/github-action-required-labels from 4.0.0 to 5.1.0 by @dependabot in #207
• Update dependabot.yml by @lopopolo in #212
• chore(deps): Bump the gha-deps group with 1 update by @dependabot in #213
• chore(deps): Bump the gha-deps group with 1 update by @dependabot in #214
• chore(deps): Bump the bundler-deps group with 1 update by @dependabot in #215
• chore(deps): Bump the bundler-deps group with 1 update by @dependabot in #216
• chore(deps): Bump the gha-deps group with 3 updates by @dependabot in #217
• chore(deps): Bump the gha-deps group with 5 updates by @dependabot in #219
• chore(deps): Bump the bundler-deps group with 1 update by @dependabot in #218
• chore(deps): Bump the gha-deps group with 4 updates by @dependabot in #221
• chore(deps): Bump the bundler-deps group with 2 updates by @dependabot in #220
• chore(deps): Bump the bundler-deps group with 1 update by @dependabot in #223
• chore(deps): Bump the gha-deps group with 1 update by @dependabot in #222
• Update Ruby and Bundler version by @lopopolo in #224
• chore(deps): Bump the gha-deps group with 1 update by @dependabot in #225
• chore(deps): Bump the bundler-deps group with 1 update by @dependabot in #226
• chore(deps): Bump the bundler-deps group with 1 update by @dependabot in #227
• chore(deps): Bump the gha-deps group with 3 updates by @dependabot in #228
• Lock prettier version for dev and CI by @lopopolo in #229
• Update Rakefile by @lopopolo in #231
• chore(deps): Bump the gha-deps group with 5 updates by @dependabot in #230
• chore(deps): Bump the bundler-deps group with 1 update by @dependabot in #232
• chore(deps): Bump the gha-deps group with 4 updates by @dependabot in #234
• chore(deps): Bump the bundler-deps group with 1 update by @dependabot in #233
• chore(deps): Bump the bundler-deps group with 2 updates by @dependabot in #236
• chore(deps): Bump the gha-deps group with 5 updates by @dependabot in #235
• chore(deps): Bump rexml from 3.2.6 to 3.2.8 by @dependabot in #237
• chore(deps): Bump the gha-deps group with 2 updates by @dependabot in #238
• chore(deps): Bump rubocop from 1.63.4 to 1.64.1 in the bundler-deps group by @dependabot in #239
• Update Ruby and bundler by @lopopolo in #241
• chore(deps): Bump the gha-deps group with 2 updates by @dependabot in #243
• chore(deps): Bump rexml from 3.2.8 to 3.3.3 by @dependabot in #246
• chore(deps): Bump the gha-deps group with 3 updates by @dependabot in #244
• chore(deps): Bump rubocop from 1.64.1 to 1.65.1 in the bundler-deps group by @dependabot in #245
• chore(deps): Bump the bundler-deps group with 2 updates by @dependabot in #249
• chore(deps): Bump the gha-deps group with 2 updates by @dependabot in #248
• chore(deps): Bump rubocop from 1.66.0 to 1.66.1 in the bundler-deps group by @dependabot in #251
• chore(deps): Bump the gha-deps group with 3 updates by @dependabot in #250
• chore(deps): Bump rubocop from 1.66.1 to 1.68.0 in the bundler-deps group by @dependabot in #253
• chore(deps): Bump ...

v5.0.0

Release 5.0.0 of boba.

boba is published on crates.io.

Breaking changes

• Remove alloc feature. boba has a required dependency on the alloc crate, but gates the availability of the alloc crate with the alloc feature. boba 4.x did not build when compiling with --no-default-features. Make alloc a non-optional dependency. #160

Testing improvements

• Add a test that the impl Display for DecodeError is non-empty. #157

Documentation improvements

• Ensure documentation builds without intradoc link errors when compiling without default features. #160
• Avoid hardcoding links to std docs when the std feature is enabled. #161

v4.3.1

Release boba 4.3.1

boba is published on crates.io.

This release contains packaging improvements:

• Remove notice from README on derived work. #142

v4.3.0

Release boba 4.3.0

boba is published on crates.io.

This release contains enhancements and performance optimizations. boba::decode is 35% faster than v4.2.0.

• Optimize encode for empty input by hardcoding the result. #135
• Minimize codebloat by moving encoder and decoder out of generic function. #136
• Optimize boba::decode. #137
• Remove bstr dependency and reimplement bits that are used in decode. #138

Improvements to dev dependencies and benchmark tooling:

• Update version-sync to 0.9.3 and trim some deps from Cargo.lock. #117
• Remove comparison benches with alternate implementation. #123
• Migrate benches to subcrate with criterion, remove nightly toolchain dep. #134

This release also includes several code quality improvements:

• Scope encoded length to block for constructing the decode buffer. #103
• Format use import statements to have groups for core + other deps. #104

This release contains improvements to documentation and build process.

v4.2.0

Release boba 4.2.0.

boba is published on crates.io.

This release fixes a bug in boba's minimal dependency declaration for bstr. #71

Updating the version of boba you depend on to 4.2 will allow boba to build when generating a lockfile with minimal depdenency versions, e.g.

cargo +nightly generate-lockfile -Z minimal-versions

Declare boba in Cargo.toml like:

[dependencies]
boba = "4.2"

v4.1.2

Release boba 4.1.2.

boba is published on crates.io.

This release contains internal code quality improvements: #66, #67.

v4.1.1

Release boba 4.1.1.

boba is published on crates.io.

This release contains enhancements:

• Avoid write! macro in fmt::Display impl for DecodeError. #62
• Add additional tests for bytes outside of the encoding alphabet. #63
• Add a (unenforced) CI job for testing boba with MSRV Rust 1.42.0. #64

This release contains improvements to documentation and build process.

v4.1.0

Release boba 4.1.0.

boba is published on crates.io.

This release contains enhancements:

• Remove doc-comment dev-dependency. #49
• Enable boba to build in a no_std + alloc configuration. #52

This release contains improvements to documentation and build process.

v4.0.0

Release boba 4.0.0.

boba is published on crates.io.

This release contains breaking changes and enhancements:

• boba v4.0.0 removes all unsafe code and boba is now #![forbid(unsafe_code)]. 🎉
• [BREAKING] Build with no_std if the std feature is not enabled. This fixes a bug in the std feature introduced in v3.0.0. v3.0.0 introduced an optional std feature. v3.0.0 claimed that boba would not build if it was deactivated, but did not enforce this behavior.
• Do not activate bstr/std feature, even if boba/std is enabled.
• Improve correctness and error handling in boba::decode:
  • Enforce that - separators appear where they are expected.
  • [BREAKING] Return more specific errors when a consonant appears where a vowel is expected.
  • [BREAKING] Return more specific errors when a vowel appears where a consonant is expected.

This release contains improvements to documentation and build process.

v3.0.0

Release boba 3.0.0.

This release renames this crate from bubblebabble to boba. boba is published on crates.io.

This release contains breaking changes and enhancements:

• Relax type constraint on boba::encode to take AsRef<[u8]>.
• Relax type constraint on boba::decode to take AsRef<[u8]>.
• [BREAKING] Squash DecodeError::{InvalidSymbol,NonAscii} into DecodeError::InvalidByte (GH-21).
• Add optional std feature, enabled by default. This activates the std feature in bstr.

This release contains many performance optimizations:

• boba::encode is 3x faster than v2.0.0.
• boba::decode is 2x faster than v2.0.0.

This release contains improvements to documentation and build process. boba::encode and boba::decode are fuzzed regularly.