v0.7.0

Breaking Changes

• Rewrite Errors
  • Errors can now be prettified with miette
  • Errors now carry the error sources including the actual errors from the failed subsystems
• Display a warning if the Toplevel object isn't consumed (via handle_shutdown_requests)
• Cancel all subsystems connected to the Toplevel object when the Toplevel object is dropped

Non-breaking changes

• Change recommended error wrapper library from anyhow to miette.
  • Compatibility to other error handling wrapper libraries stays unchanged.
• Add IntoSubsystem trait to make writing struct-based subsystems more convenient

v0.6.0

Breaking Changes

• Subsystems can return Err<Into<Box<dyn Error + Send + Sync>>> instead of Err<Into<anyhow::Error>>
  • Allows all error types that can be converted to Box<dyn Error + Send + Sync>
  • Should be compatible with existing code, but increases compatibility with new error handling crates
• Toplevel::handle_shutdown_requests can now return all types that implement From<GracefulShutdownError>, which should integrate seamlessly with most return types from main(), like anyhow::Result, Box<dyn Error> or eyre::Result

v0.6.0-beta.0

Breaking Changes

• Subsystems can return Err<Into<Box<dyn Error + Send + Sync>>> instead of Err<Into<anyhow::Error>>
  • Allows all error types that can be converted to Box<dyn Error + Send + Sync>
  • Should be compatible with existing code, but increases compatibility with new error handling crates
• Toplevel::handle_shutdown_requests can now return all types that implement From<GracefulShutdownError>, which should integrate seamlessly with most return types from main(), like anyhow::Result, Box<dyn Error> or eyre::Result

v0.5.0

Breaking Changes

• Subsystems can return Err<Into<anyhow::Error>> instead of Err<anyhow::Error>
  • No longer imposes the anyhow dependency on library users
  • Should not be a problem in most cases, but closures only returning Ok(()) will now fail to compile, as Rust is unable to deduce the Error type

v0.4.4

Changes

• Make SubsystemHandle::start() a non-mut function (@Trivernis)
  • This removes the necessity of the handle argument to be mut, making it much easiert to pass it around, to store it in structs and to use it as a shared reference.

v0.4.3

Changes

• Fix: Errors during partial shutdown no longer cause global shutdown.
  • Instead, errors get properly delivered to the task that issued the partial shutdown.

v0.4.2

Changes

• Reduce Rust version to 2018
  • Adds compatibility with Rust 2018 projects

v0.4.1

Breaking Changes

• Rename Toplevel::wait_for_shutdown to Toplevel::handle_shutdown_requests to make it clearer what the purpose of this function is
• Implement partial shutdown API
  • Change return value of SubsystemHandle::create() to NestedSubsystem
  • Add SubsystemHandle::perform_partial_shutdown(NestedSubsystem)
  • Add NestedSubsystem struct and PartialShutdownError enum

v0.3.2

Changes

• Subsystems now get cancelled if the Toplevel object gets dropped
• Fixes in documentation

v0.3.1

Changes

• Rewrite panic handling to no longer use panic hooks

This should have no effect on the API itself. It is mainly an improvement in the interaction with other libraries that use panic hooks.