Commits on Jun 27, 2022

1. time: 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 non-unstable public APIs in
   tokio-util 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 public functions that could not have `#[track_caller]` added for
   this reason are:
   * `time::advance`
   
   Tests are included to cover each potentially panicking function. In the
   following cases, `#[track_caller]` had already been added, and only
   tests have been added:
   * `time::interval`
   * `time::interval_at`
   
   Refs: tokio-rs#4413

   

   hds committed Jun 27, 2022
   Copy the full SHA

   94f1863 View commit details

   Browse the repository at this point in the history