chore(backend): change From<T> impls to new backend specific IntoBackend and FromBackend traits #1464
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Follows up from #1460 (comment) |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1464 +/- ##
=======================================
- Coverage 93.5% 93.4% -0.1%
=======================================
Files 68 68
Lines 16888 16875 -13
=======================================
- Hits 15795 15778 -17
- Misses 1093 1097 +4 ☔ View full report in Codecov by Sentry. |
joshka
force-pushed
the
jm/crossterm-conversion-methods
branch
2 times, most recently
from
b5f6ba1 to
f7ad9cc
Compare
|
Followup |
…term
Adds two new traits `IntoCrossterm` and `FromCrossterm` for converting
between ratatui and crossterm types. This is necessary in order to avoid
the orphan rule when implementing `From` for crossterm types once the
crossterm types are moved to a separate crate.
BREAKING CHANGE: The `From` impls for crossterm types are now replaced
with `IntoCrossterm` and `FromCrossterm` traits.
```diff
+ use ratatui::backend::{FromCrossterm, IntoCrossterm};
let crossterm_color = crossterm::style::Color::Black;
- let ratatui_color = crossterm_color.into();
- let ratatui_color = ratatui::style::Color::from(crossterm_color);
+ let ratatui_color = ratatui::style::Color::from_crossterm(crossterm_color);
- let crossterm_color = ratatui_color.into();
- let crossterm_color = crossterm::style::Color::from(ratatui_color);
+ let crossterm_color = ratatui_color.into_crossterm();
let crossterm_attribute = crossterm::style::types::Attribute::Bold;
- let ratatui_modifier = crossterm_attribute.into();
- let ratatui_modifier = ratatui::style::Modifier::from(crossterm_attribute);
+ let ratatui_modifier = ratatui::style::Modifier::from_crossterm(crossterm_attribute);
- let crossterm_attribute = ratatui_modifier.into();
- let crossterm_attribute = crossterm::style::types::Attribute::from(ratatui_modifier);
+ let crossterm_attribute = ratatui_modifier.into_crossterm();
```
Similar conversions for `ContentStyle` -> `Style` and
`Attributes` -> `Modifier` exist.
joshka
force-pushed
the
jm/crossterm-conversion-methods
branch
from
f7ad9cc to
76499dc
Compare
Bencher Report
joshka
changed the title
joshka
force-pushed
the
jm/crossterm-conversion-methods
branch
from
81d5adf to
cd66b2f
Compare
orhun
approved these changes
Nov 3, 2024
Axum has:
This should mostly be unused as there's unlikely be a lot of crates that convert backend types to / from ratatui types, but for those that need it, it makes sense not to repeat the code. |
This was referenced Feb 11, 2025
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds two traits
IntoCrosstermandFromCrosstermfor convertingbetween ratatui and crossterm types. This is necessary in order to avoid
the orphan rule when implementing
Fromfor crossterm types once thecrossterm types are moved to a separate crate.
Similarly Termwiz and Termwiz gain FromTermion, IntoTermion, FromTermwiz
and IntoTermwiz traits.
BREAKING CHANGE: The
FromandIntoimpls for backend types are now replacedwith specific backend traits.
Similar conversions for
ContentStyle->StyleandAttributes->Modifierexist for Crossterm,and all the Termion and Termwiz types.