feat(tui-big-text)!: make BigText builder infallible
#14
Conversation
This file contains 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
BigTextBuilder.build() no longer returns a Result. Instead it returns
the BigText widget directly. This change is made to simplify rendering
code which often otherwise doesn't have any error conditions.
BREAKING CHANGE: BigTextBuilder.build() no longer returns a Result.
Remove the `?` / `expect` / `unwrap` calls code which calls the build
method.
```diff
let big_text = BigText::builder()
.lines(vec![Line::from("SingleLine")])
- .build()?;
+ .build();
```
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #14 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 2 2
Lines 136 136
=====================================
Misses 136 136 ☔ View full report in Codecov by Sentry. |
Merged
joshka
pushed a commit
that referenced
this pull request
Jul 25, 2024
## 🤖 New release * `tui-big-text`: 0.4.7 -> 0.5.0 * `tui-widgets`: 0.1.5 -> 0.2.0 <details><summary><i><b>Changelog</b></i></summary><p> ## `tui-big-text` <blockquote> ## [0.5.0] - 2024-07-25 ### 🚀 Features - *(tui-big-text)* Add alignment helper methods > Adds helper methods to the `BigTextBuilder` struct to set the alignment > of the text. This makes it simpler to set the alignment of the text. > > ```rust > let left = BigText::builder() > .left_aligned() > .lines(vec!["Left".white().into()]) > .build()?; > > let right = BigText::builder() > .right_aligned() > .lines(vec!["Right".green().into()]) > .build()?; > > let centered = BigText::builder() > .centered() > .lines(vec!["Centered".red().into()]) > .build()?; > ``` - *(tui-big-text)* [**breaking**] Make `BigText` builder infallible ([#14](#14)) > BigTextBuilder.build() no longer returns a Result. Instead it returns > the BigText widget directly. This change is made to simplify rendering > code which often otherwise doesn't have any error conditions. > > This also makes the fields on BigText public (marked as non-exhaustive) > > BREAKING CHANGE:BigTextBuilder.build() no longer returns a Result. > > Remove the `?` / `expect` / `unwrap` calls code which calls the build > method. > > ```diff > let big_text = BigText::builder() > .lines(vec![Line::from("SingleLine")]) > - .build()?; > + .build(); > ``` ### 📚 Documentation - Simplify tui-big-text examples <!-- generated by git-cliff --> </blockquote> ## `tui-widgets` <blockquote> ## [0.2.0] - 2024-07-25 ### 🚀 Features - *(tui-big-text)* Add alignment helper methods > Adds helper methods to the `BigTextBuilder` struct to set the alignment > of the text. This makes it simpler to set the alignment of the text. > > ```rust > let left = BigText::builder() > .left_aligned() > .lines(vec!["Left".white().into()]) > .build()?; > > let right = BigText::builder() > .right_aligned() > .lines(vec!["Right".green().into()]) > .build()?; > > let centered = BigText::builder() > .centered() > .lines(vec!["Centered".red().into()]) > .build()?; > ``` - *(tui-big-text)* [**breaking**] Make `BigText` builder infallible ([#14](#14)) > BigTextBuilder.build() no longer returns a Result. Instead it returns > the BigText widget directly. This change is made to simplify rendering > code which often otherwise doesn't have any error conditions. > > This also makes the fields on BigText public (marked as non-exhaustive) > > BREAKING CHANGE:BigTextBuilder.build() no longer returns a Result. > > Remove the `?` / `expect` / `unwrap` calls code which calls the build > method. > > ```diff > let big_text = BigText::builder() > .lines(vec![Line::from("SingleLine")]) > - .build()?; > + .build(); > ``` ### 📚 Documentation - Fixup readme - Simplify tui-big-text examples ### ⚙️ Miscellaneous Tasks - Include commit body in changelog <!-- generated by git-cliff --> </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
BigTextBuilder.build() no longer returns a Result. Instead it returns
the BigText widget directly. This change is made to simplify rendering
code which often otherwise doesn't have any error conditions.
This also makes the fields on BigText public (marked as non-exhaustive)
BREAKING CHANGE: BigTextBuilder.build() no longer returns a Result.
Remove the
?/expect/unwrapcalls code which calls the buildmethod.
let big_text = BigText::builder() .lines(vec![Line::from("SingleLine")]) - .build()?; + .build();