Commits on Jul 5, 2022

1. sync: add track_caller to public APIs …

   Functions that may panic can be annotated with `#[track_caller]` so that
   in the event of a panic, the function where the user called the
   panicking function is shown instead of the file and line within Tokio
   source.
   
   This change adds `#[track_caller]` to all the public APIs in the sync
   module of the tokio crate where the documentation describes how the
   function may panic due to incorrect context or inputs.
   
   In cases where `#[track_caller]` does not work, it has been left out.
   For example, it currently does not work on async functions, blocks, or
   closures. So any call stack that passes through one of these before
   reaching the actual panic is not able to show the calling site outside
   of tokio as the panic location.
   
   The following functions have call stacks that pass through closures:
   * `sync::watch::Sender::send_modify`
   * `sync::watch::Sender::send_if_modified`
   
   Additionally, in the above functions it is a panic inside the supplied
   closure which causes the function to panic, and so showing the location
   of the panic itself is desirable.
   
   The following functions are async:
   * `sync::mpsc::bounded::Sender::send_timeout`
   
   Tests are included to cover each potentially panicking function.
   
   Refs: tokio-rs#4413

   

   hds committed Jul 5, 2022
   Copy the full SHA

   4783174 View commit details

   Browse the repository at this point in the history