Skip to content

Commit

Permalink
chore: update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
@polazarus
polazarus committed Dec 30, 2024
1 parent 1eb22eb commit 456dab0
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 21 deletions.
15 changes: 12 additions & 3 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,21 @@ Notable changes only.

## Unreleased

### Added
### Added

- add new unique (non-shared) strings and byte vectors
- add `as_borrowed`
- add inline `const` constructors

### Changed

- refactor the backend to support unique
- refactor the backend to support unique references
- remove low-level `Raw` type
- improve deserialization for strings, bytes and paths, see [#38](https://github.com/polazarus/hipstr/pull/38) and follow-up work

### Removed

- dependency to `serde_bytes`

## [0.6.0] - 2024-10-08

Expand All @@ -19,7 +27,7 @@ Notable changes only.
- implement `core::error:Error` for custom errors, rather than
`std::error::Error` and bump msrv

### Fixed
### Fixe

- fix doc issue [#28](https://github.com/polazarus/hipstr/issues/28)
- fix MIRI check due to provenance loss
Expand Down Expand Up @@ -137,6 +145,7 @@ Most of those addition are breaking because they shadows `str`'s methods.
Initial release

<!-- [unreleased]: https://github.com/polazarus/hipstr/compare/0.6.1...HEAD -->

[0.6.0]: https://github.com/polazarus/hipstr/compare/0.5.1...0.6.0
[0.5.1]: https://github.com/polazarus/hipstr/compare/0.5.0...0.5.1
[0.5.0]: https://github.com/polazarus/hipstr/compare/0.4.0...0.5.0
Expand Down
38 changes: 20 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,24 +129,26 @@ Note: this crate leverages the "exposed provenance" semantics.

`#[non_exhaustive]`

| Name | Thread-safe cheap-clone | Local cheap-clone | Inline | Cheap slice | Bytes | Borrow `'static` | Borrow any `'a` | Comment |
| -------------------------------------------------------------- | ----------------------- | ----------------- | ------ | ----------- | ------ | ---------------- | :-------------- | ------------------------------------------------------------------------------------------------------ |
| `hipstr` | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | obviously! |
| [`arcstr`](https://github.com/thomcc/arcstr) | 🟢\* | ❌ | ❌ | ❌\*\* | ❌ | 🟢 | ❌ | \*use a custom thin `Arc`, \*\*heavy slice (with dedicated substring type) |
| [`flexstr`](https://github.com/nu11ptr/flexstr) | 🟢\* | 🟢 | 🟢 | ❌ | ❌ | 🟢 | ❌ | \*use an `Arc<str>` instead of an `Arc<String>` (remove one level of indirection but use fat pointers) |
| [`imstr`](https://github.com/xfbs/imstr) | 🟢 | 🟢 | ❌ | 🟢 | ❌ | ❌ | ❌ | |
| [`faststr`](https://github.com/volo-rs/faststr) | 🟢 | ❌ | 🟢 | 🟢 | ❌ | 🟢 | ❌ | zero-doc with complex API |
| [`fast-str`](https://github.com/xxXyh1908/rust-fast-str) | 🟢 | ❌ | 🟢 | 🟢 | ❌ | 🟢 | ❌ | inline repr is opt-in |
| [`ecow`](https://github.com/typst/ecow) | 🟢\* | ❌ | 🟢 | ❌ | 🟢\*\* | 🟢 | ❌ | \*on two words only 🤤, \*\*even any `T` |
| [`cowstr`](https://git.pipapo.org/cehteh/cowstr.git) | 🟢 | ❌ | ❌ | ❌\* | ❌ | 🟢 | ❌\*\* | \*heavy slice, \*\*contrary to its name |
| [`compact_str`](https://github.com/parkmycar/compact_str) | ❌ | ❌ | 🟢 | ❌ | 🟢\* | ❌ | ❌ | \*opt-in via `smallvec` |
| [`inline_string`](https://github.com/fitzgen/inlinable_string) | ❌ | ❌ | 🟢 | ❌ | ❌ | ❌ | ❌ | |
| [`kstring`](https://docs.rs/kstring/latest/kstring/) | 🟢 | ❌ | 🟢 | ❌ | ❌ | 🟢 | ❌ | |
| [`smartstring`](https://github.com/bodil/smartstring) | ❌ | ❌ | 🟢 | ❌ | ❌ | ❌ | ❌ | |
| [`smallstr`](https://github.com/murarth/smallstr) | ❌ | ❌ | 🟢 | ❌ | ❌ | ❌ | ❌ | |
| [`smol_str`](https://github.com/rust-analyzer/smol_str) | ❌ | ❌ | 🟢\* | ❌ | ❌ | 🟢 | ❌ | \*but only inline string, here for reference |

skipping specialized string types like [`tinystr`](https://github.com/unicode-org/icu4x) (ASCII-only, bounded), or `bstr`, or `bytestring`, or...
| Name | TS cheap-clone | Local cheap-clone | Inline | Cheap slice | Bytes | Borrow `'static` | Borrow any `'a` | Comment |
| -------------------------------------------------------------- | -------------- | ----------------- | ------ | ----------- | ----- | ---------------- | :-------------- | -------------------------------------------------------------------------------------------------- |
| `hipstr` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | obviously! |
| [`arcstr`](https://github.com/thomcc/arcstr) | ✓\* | - | - | -\*\* | - | ✓ | - | \*use a custom thin `Arc`, \*\*heavy slice (with dedicated substring type) |
| [`flexstr`](https://github.com/nu11ptr/flexstr) | ✓\* | ✓ | ✓ | - | - | ✓ | - | \*use `(A)rc<str>` instead of `(A)rc<String>` (remove a level of indirection but use fat pointers) |
| [`imstr`](https://github.com/xfbs/imstr) | ✓ | ✓ | - | ✓ | - | - | - | |
| [`faststr`](https://github.com/volo-rs/faststr) | ✓ | - | ✓ | ✓ | - | ✓ | - | zero-doc with complex API |
| [`fast-str`](https://github.com/xxXyh1908/rust-fast-str) | ✓ | - | ✓ | ✓ | - | ✓ | - | inline repr is opt-in |
| [`ecow`](https://github.com/typst/ecow) | ✓\* | - | ✓ | - | ✓\*\* | ✓ | - | \*on two words only 🤤, \*\*even any `T` |
| [`cowstr`](https://git.pipapo.org/cehteh/cowstr.git) | ✓ | - | - | -\* | - | ✓ | -\*\* | \*heavy slice, \*\*contrary to its name |
| [`compact_str`](https://github.com/parkmycar/compact_str) | - | - | ✓ | - | ✓\* | - | - | \*opt-in via `smallvec` |
| [`inline_string`](https://github.com/fitzgen/inlinable_string) | - | - | ✓ | - | - | - | - | |
| [`kstring`](https://docs.rs/kstring/latest/kstring/) | ✓ | ✓ | ✓ | - | - | ✓ | ✓\* | safe mode, use boxed strings; \* with second type |
| [`smartstring`](https://github.com/bodil/smartstring) | - | - | ✓ | - | - | - | - | |
| [`smallstr`](https://github.com/murarth/smallstr) | - | - | ✓ | - | - | - | - | |
| [`smol_str`](https://github.com/rust-analyzer/smol_str) | - | - | ✓\* | - | - | ✓ | - | \*but only inline string, here for reference |

skipping specialized string types like
[`tinystr`](https://github.com/unicode-org/icu4x) (ASCII-only, bounded), or
`bstr`, or `bytestring`, or...

In short, `HipStr`, one string type to rule them all 😉

Expand Down

0 comments on commit 456dab0

Please sign in to comment.