Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Custom debug implementation for Vcs (vercel/turborepo#193)
This PR builds our own `Debug`-like derive-macro machinery for formatting structs, relying on `std::fmt::Formatter` for the actual formatting. ### Usage A new `ValueDebug` trait is automatically implemented for all `#[turbo_tasks::value]`s, which has a single `.dbg()` method which resolves to a debug representation that can then be printed to the screen. `#[turbo_tasks::value_trait]` also implement the `.dbg()` method directly. ```rust dbg!(any_vc.dbg().await?); ``` If you have a `#[turbo_tasks::value]` struct with a field that doesn't implement `Debug`, you'll want to declare that field as `#[debug_ignore]`. For instance: ```rust #[turbo_tasks::value(ContentSource, serialization: none, eq: manual, cell: new, into: new)] pub struct TurboTasksSource { #[debug_ignore] #[trace_ignore] pub turbo_tasks: Arc<TurboTasks<MemoryBackend>>, } ``` ### Why not use `Debug` directly? We can't use `Debug` because our values are resolved asynchronously and can nest `Vc`s arbitrarily. I tried using `futures::executor::block_on` to resolve them synchronously in a `Debug` implementation but that causes deadlocks.
- Loading branch information