Skip to content

Name every subsystem that emits an event, not only the cache #484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iderex merged 1 commit into from
Sep 18, 2026
+17 −6
Merged

Name every subsystem that emits an event, not only the cache #484

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions src/diagnostics/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,15 @@
//!
//! # Which events exist today
//!
//! The cache's, and nobody else's. [`crate::cache::bound`] emits one when a full
//! device suspends writing and one when artwork gives way to metadata, and
//! [`crate::cache::envelope`] emits one when an entry is dropped for failing its
//! check. Which names those are is read out of the tree rather than listed here,
//! because a list in this module goes stale against the modules that declare
//! them: `git grep -n 'EventName::declared' -- src/`.
//! The cache's, the write queue's and the session's. [`crate::cache::bound`]
//! emits one when a full device suspends writing and one when artwork gives way
//! to metadata, [`crate::cache::envelope`] emits one when an entry is dropped
//! for failing its check, [`crate::server::write_queue`] emits one when an
//! overflow drops the oldest entry, and [`crate::session::mid_playback`] emits
//! one when a session can no longer report a position. Which names those are is
//! read out of the tree rather than listed here, because a list in this module
//! goes stale against the modules that declare them:
//! `git grep -n 'EventName::declared' -- src/`.
//!
//! THIS SECTION READ "NONE. NOTHING IN THIS TREE EMITS ONE, BECAUSE NO SUBSYSTEM
//! THAT WOULD IS BUILT." It was true on 2026-08-26, when it landed, and stopped
Expand All @@ -47,6 +50,14 @@
//! refuted, which is the milder of the two states and is worth saying in those
//! words. #442 is where it was found.
//!
//! IT THEN READ "THE CACHE'S, AND NOBODY ELSE'S", WHICH IS THE OTHER OF THOSE
//! TWO STATES. The session declared and emitted its event on 2026-09-03 and the
//! write queue on 2026-09-04, and the sentence denying them landed on 2026-09-18
//! as the repair recorded above, so it landed refuted rather than going stale.
//! The command this section already hands a reader returned both of them on the
//! day that sentence was written, which is what makes this the harder of the two
//! to defend. #483 is where it was found.
//!
//! THAT SENTENCE ALSO SENT A READER TO [`crate::session`] FOR THE SAME SENTENCE,
//! AND NOTHING OF THAT SHAPE IS IN THAT MODULE. The pointer is deleted rather
//! than repaired, because what it pointed at cannot be found to repair.
Expand Down
Loading