Cursor refactoring

[zrzka]

• Internal refactoring
  • No breaking changes except one - sys module is private
• Forbids unused_must_use warning -> error
• Improves documentation
  • Only the part available at docs.rs
  • Internal documentation not touched

You can check the documentation via cd crossterm_cursor && cargo doc --open.

[TimonPost]

We can use ScreenBufferCursor directly because we are using winapi here and thus there is no need to go through the abstraction of ansi/winapi

[zrzka]

Disagree here as it's an implementation detail of the crossterm_cursor crate (private sys module).

[TimonPost]

Should I wait for the series of refactors concerning the 'I' in the trait names before doing the 0.11 release? As long there are no breaking changes in those PR's we can move them to 0.11.1 as well

[zrzka]

Should I wait for the series of refactors concerning the 'I' before doing the 0.11 release?

No need to wait because this refactoring is internal and doesn't change public API (except closing sys modules). Assuming similar situation is in other crates.

[TimonPost]

Let's move this over to 0.11.1, see #243, let's do the 0.11 release tomorrow. My guess is that nobody is using 'sys' altough am I allowed assuming such thing?

[zrzka]

It's impossible to say if anyone is using it or not. It's a breaking change of the crossterm_cursor crate only, not the crossterm crate, because it doesn't reexport sys modules.

Anyway, this wasn't meant to be included in 0.11 release. It's mainly about cursor doc & refactor and to say if it's okay to use the same schema for other sub crates or if there's anything you'd like to change before I proceed with remaining sub crates (in separate PRs).

[zrzka]

Closing. Same PR will be against separate repo once I finish separation tmw.