Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-25 06:00:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

add breaking change doc

Browse source
This commit is contained in:
Josh McKinney 2024-08-25 01:35:38 -07:00
parent f08640c53b
commit e084c9f013
No known key found for this signature in database
GPG key ID: 722287396A903BC5
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
BREAKING-CHANGES.md
View file

@ -11,6 +11,7 @@ GitHub with a [breaking change] label.
This is a quick summary of the sections below: This is a quick summary of the sections below:
- [v0.29.0](#unreleased) - [v0.29.0](#unreleased)
- `Terminal`, `Buffer`, `Cell`, `Frame` are no longer `Sync` / `RefUnwindSafe`
- Removed public fields from `Rect` iterators - Removed public fields from `Rect` iterators
- `Line` now implements `From<Cow<str>` - `Line` now implements `From<Cow<str>`
- `Table::highlight_style` is now `Table::row_highlight_style` - `Table::highlight_style` is now `Table::row_highlight_style`
@ -72,6 +73,17 @@ This is a quick summary of the sections below:
## Unreleased ## Unreleased
### `Terminal`, `Buffer`, `Cell`, `Frame` are no longer `Sync` / `RefUnwindSafe` [#1339]
[#1339]: https://github.com/ratatui/ratatui/pull/1339
In #1339, we added a cache of the Cell width which uses a std::cell::Cell. This causes `Cell` and
all types that contain this (`Terminal`, `Buffer`, `Frame`, `CompletedFrame`, `TestBackend`) to no
longer be `Sync`
This change is unlikely to cause problems as these types likely should not be sent between threads
regardless due to their interaction with various things which mutated externally (e.g. stdio).
### Removed public fields from `Rect` iterators ([#1358]) ### Removed public fields from `Rect` iterators ([#1358])
[#1358]: https://github.com/ratatui/ratatui/pull/1358 [#1358]: https://github.com/ratatui/ratatui/pull/1358