Libera-Chat / sable

GNU Affero General Public License v3.0
84 stars 8 forks source link

Improve compiler diagnostic when HandlerFn is not implemented #125

Closed progval closed 5 months ago

progval commented 5 months ago

For example, if I add a u64 parameter to a handler, the compiler now reports this:

error[E0277]: Invalid command handler
  --> sable_ircd/src/command/handlers/who.rs:5:1
   |
5  | #[command_handler("WHO")]
   | ^^^^^^^^^^^^^^^^^^^^^^^^^ `for<'a, 'b, 'c, 'd, 'e> fn(&'a server::ClientServer, &'b sable_network::prelude::Network, &'c (dyn command_response::CommandResponse + 'c), source_types::UserSource<'d>, &'e str, u64) -> Result<(), command::error::CommandError> {handle_who}` is not a valid command handler
   |
   = help: the trait `handler::HandlerFn<'_, _, _>` is not implemented for fn item `for<'a, 'b, 'c, 'd, 'e> fn(&'a server::ClientServer, &'b sable_network::prelude::Network, &'c (dyn command_response::CommandResponse + 'c), source_types::UserSource<'d>, &'e str, u64) -> Result<(), command::error::CommandError> {handle_who}`
   = note: All parameter types must implement `AmbientArgument` or `PositionalArgument`
   = note: Return type must be `CommandResult`
note: required by a bound in `call_handler`
  --> sable_ircd/src/command/plumbing/mod.rs:47:20
   |
45 | pub(crate) fn call_handler<'a, Amb, Pos>(
   |               ------------ required by a bound in this function
46 |     ctx: &'a dyn Command,
47 |     handler: &impl HandlerFn<'a, Amb, Pos>,
   |                    ^^^^^^^^^^^^^^^^^^^^^^^ required by this bound in `call_handler`
   = note: this error originates in the attribute macro `command_handler` (in Nightly builds, run with -Z macro-backtrace for more info)

instead of this:

error[E0277]: the trait bound `for<'a, 'b, 'c, 'd, 'e> fn(&'a server::ClientServer, &'b sable_network::prelude::Network, &'c (dyn command_response::CommandResponse + 'c), source_types::UserSource<'d>, &'e str, u64) -> Result<(), command::error::CommandError> {handle_who}: handler::HandlerFn<'_, _, _>` is not satisfied
  --> sable_ircd/src/command/handlers/who.rs:5:1
   |
5  | #[command_handler("WHO")]
   | ^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `handler::HandlerFn<'_, _, _>` is not implemented for fn item `for<'a, 'b, 'c, 'd, 'e> fn(&'a server::ClientServer, &'b sable_network::prelude::Network, &'c (dyn command_response::CommandResponse + 'c), source_types::UserSource<'d>, &'e str, u64) -> Result<(), command::error::CommandError> {handle_who}`
   |
note: required by a bound in `call_handler`
  --> sable_ircd/src/command/plumbing/mod.rs:47:20
   |
45 | pub(crate) fn call_handler<'a, Amb, Pos>(
   |               ------------ required by a bound in this function
46 |     ctx: &'a dyn Command,
47 |     handler: &impl HandlerFn<'a, Amb, Pos>,
   |                    ^^^^^^^^^^^^^^^^^^^^^^^ required by this bound in `call_handler`
   = note: this error originates in the attribute macro `command_handler` (in Nightly builds, run with -Z macro-backtrace for more info)

This uses the diagnostic::on_unimplemented attribute stabilized by Rust 1.78

I believe it can make it a little easier for people getting started with the codebase. What do you think?