Update documentation: breaking (?) change 7>8; `use uuid::parser::ParseError`

[Luca829]

Is your feature request related to a problem? Please describe.
I changed the version of uuid from 7 to 8.1 and the following statement

use uuid::parser::ParseError;

gives me the compilation error:

error[E0432]: unresolved import `uuid::parser::ParseError`
  --> src/errors.rs:11:5
   |
11 | use uuid::parser::ParseError;
   |     ^^^^^^^^^^^^^^^^^^^^^^^^ no `ParseError` in `parser`

Describe the solution you'd like
The solution would be to amend the documentation of uuid and add a breaking change from version 7 to version 8

Is it blocking?
Yes, but only me alone...

Describe alternatives you've considered
I can go back to version 7 and the error is gone. But on the long this is not a solution, IMHO

Additional context
I'm playing (trying to replicate/change) with https://github.com/ddimaria/rust-actix-example/blob/master/src/errors.rs

Other
Probably the change in the lib implies a refactoring of the mentioned code

https://github.com/ddimaria/rust-actix-example/blob/master/src/errors.rs

[Dylan DPC]

Thanks for creating this issue. yeah we have renamed it here. I'm not sure if we mentioned in anywhere, we should add it to the documentation in the next release if it doesn't exist.

[Luca829]

Thank you for your feedback. If I try use uuid::parser::error::Error as ParseError; I get the error that parser is not pub (which is not). How is the Enum accessed in the version 8?

[Dylan DPC]

can you try use uuid::UuidParseError? (we re-export it iirc)

(sorry )

[Hunar Roop Kahlon]

@KodrAus should we get this in the next release since this is just documentation?

[Ashley Mannix]

I think this looks like something that belongs in our release notes. I wouldn't expect to find documentation about changes made between version in the crate docs themselves.

Our release notes for 0.8.0 were mostly a drop of PRs because we built it up over a long time. For our next breaking release we should try pull out any visibly breaking changes more so people know what to expect.

[Ashley Mannix]

can you try use uuid::UuidParseError? (we re-export it iirc)

Ah I think we just have a single top-level uuid::Error type now that everything uses. So there aren't individual ParseErrors or anything like that.

[Ashley Mannix]

Since breaking changes are expected between 0.x bumps I don't think there's anything more to do here, except to spend a little more time on our release notes for the next one 🙂