impl Debug for handles, command types, and ResourceController

Author: tesselode

changelog.md

@@ -3,6 +3,7 @@
 - Fix sounds stopping after having already started if the clock they were originally
   waiting on stops
 - Implement `Default` for `Region`, `EndPosition`, `PlaybackPosition`, and `Value`
+- Implement `Debug` for handles, command types, and `ResourceController`
 
 # v0.9.0 - May 11, 2024
 

crates/kira/src/clock.rs

@@ -181,6 +181,7 @@ use self::clock_info::ClockInfoProvider;
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub struct ClockId(pub(crate) Key);
 
+#[derive(Debug)]
 pub(crate) struct ClockShared {
 	ticking: AtomicBool,
 	ticks: AtomicU64,

crates/kira/src/clock/handle.rs

@@ -8,6 +8,7 @@ use super::{ClockId, ClockShared, ClockSpeed, ClockTime, CommandWriters};
 ///
 /// When a [`ClockHandle`] is dropped, the corresponding clock
 /// will be removed.
+#[derive(Debug)]
 pub struct ClockHandle {
 	pub(crate) id: ClockId,
 	pub(crate) shared: Arc<ClockShared>,

crates/kira/src/command.rs

@@ -24,6 +24,7 @@ use triple_buffer::{triple_buffer, Input, Output};
 use crate::tween::{Tween, Value};
 
 /** Writes values that can be sent to a [`CommandReader`]. */
+#[derive(Debug)]
 pub struct CommandWriter<T: Send + Copy>(Input<Option<T>>);
 
 impl<T: Send + Copy> CommandWriter<T> {
@@ -34,6 +35,7 @@ impl<T: Send + Copy> CommandWriter<T> {
 }
 
 /** Reads values that were written to a [`CommandWriter`]. */
+#[derive(Debug)]
 pub struct CommandReader<T: Send + Copy>(Output<Option<T>>);
 
 impl<T: Send + Copy> CommandReader<T> {
@@ -124,10 +126,12 @@ pub(crate) fn command_writers_and_readers() -> (CommandWriters, CommandReaders)
 #[macro_export]
 macro_rules! command_writers_and_readers {
 	($($field_name:ident: $type:ty),*$(,)?) => {
+		#[derive(Debug)]
 		pub(crate) struct CommandWriters {
 			$($field_name: $crate::command::CommandWriter<$type>),*
 		}
 
+		#[derive(Debug)]
 		pub(crate) struct CommandReaders {
 			$($field_name: $crate::command::CommandReader<$type>),*
 		}

crates/kira/src/effect/compressor/handle.rs

@@ -5,6 +5,7 @@ use crate::command::handle_param_setters;
 use super::CommandWriters;
 
 /// Controls a compressor.
+#[derive(Debug)]
 pub struct CompressorHandle {
 	pub(super) command_writers: CommandWriters,
 }

crates/kira/src/effect/delay/handle.rs

@@ -3,6 +3,7 @@ use crate::{command::handle_param_setters, Volume};
 use super::CommandWriters;
 
 /// Controls a delay effect.
+#[derive(Debug)]
 pub struct DelayHandle {
 	pub(super) command_writers: CommandWriters,
 }

crates/kira/src/effect/distortion/handle.rs

@@ -3,6 +3,7 @@ use crate::{command::handle_param_setters, Volume};
 use super::{CommandWriters, DistortionKind};
 
 /// Controls a distortion effect.
+#[derive(Debug)]
 pub struct DistortionHandle {
 	pub(super) command_writers: CommandWriters,
 }

crates/kira/src/effect/eq_filter/handle.rs

@@ -3,6 +3,7 @@ use crate::command::handle_param_setters;
 use super::{CommandWriters, EqFilterKind};
 
 /// Controls an EQ filter.
+#[derive(Debug)]
 pub struct EqFilterHandle {
 	pub(super) command_writers: CommandWriters,
 }

crates/kira/src/effect/filter/handle.rs

@@ -3,6 +3,7 @@ use crate::command::handle_param_setters;
 use super::{CommandWriters, FilterMode};
 
 /// Controls a filter effect.
+#[derive(Debug)]
 pub struct FilterHandle {
 	pub(super) command_writers: CommandWriters,
 }

crates/kira/src/effect/panning_control/handle.rs

@@ -3,6 +3,7 @@ use crate::command::handle_param_setters;
 use super::CommandWriters;
 
 /// Controls a panning control effect.
+#[derive(Debug)]
 pub struct PanningControlHandle {
 	pub(super) command_writers: CommandWriters,
 }

crates/kira/src/effect/reverb/handle.rs

@@ -3,6 +3,7 @@ use crate::command::handle_param_setters;
 use super::CommandWriters;
 
 /// Controls a reverb effect.
+#[derive(Debug)]
 pub struct ReverbHandle {
 	pub(super) command_writers: CommandWriters,
 }

crates/kira/src/effect/volume_control/handle.rs

@@ -3,6 +3,7 @@ use crate::{command::handle_param_setters, Volume};
 use super::CommandWriters;
 
 /// Controls a volume control effect.
+#[derive(Debug)]
 pub struct VolumeControlHandle {
 	pub(super) command_writers: CommandWriters,
 }

crates/kira/src/manager/backend/resources.rs

@@ -7,7 +7,10 @@ pub(crate) mod spatial_scenes;
 #[cfg(test)]
 mod test;
 
-use std::sync::Mutex;
+use std::{
+	fmt::{Debug, Formatter},
+	sync::Mutex,
+};
 
 use crate::{
 	arena::{Arena, Controller, Key},
@@ -236,6 +239,32 @@ impl<T> ResourceController<T> {
 	}
 }
 
+impl<T> Debug for ResourceController<T> {
+	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+		f.debug_struct("ResourceController")
+			.field("arena_controller", &self.arena_controller)
+			.field("new_resource_producer", &HeapProducerDebug)
+			.field("unused_resource_consumer", &HeapConsumerDebug)
+			.finish()
+	}
+}
+
+struct HeapProducerDebug;
+
+impl Debug for HeapProducerDebug {
+	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+		f.debug_struct("HeapProducer").finish()
+	}
+}
+
+struct HeapConsumerDebug;
+
+impl Debug for HeapConsumerDebug {
+	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+		f.debug_struct("HeapConsumer").finish()
+	}
+}
+
 pub(crate) struct Resources {
 	pub sounds: Sounds,
 	pub mixer: Mixer,

crates/kira/src/modulator/lfo.rs

@@ -126,6 +126,7 @@ impl Waveform {
 	}
 }
 
+#[derive(Debug)]
 struct LfoShared {
 	removed: AtomicBool,
 }

crates/kira/src/modulator/lfo/handle.rs

@@ -5,6 +5,7 @@ use crate::{command::handle_param_setters, modulator::ModulatorId};
 use super::{CommandWriters, LfoShared, Waveform};
 
 /// Controls an LFO modulator.
+#[derive(Debug)]
 pub struct LfoHandle {
 	pub(super) id: ModulatorId,
 	pub(super) command_writers: CommandWriters,

crates/kira/src/modulator/tweener.rs

@@ -122,6 +122,7 @@ enum State {
 	},
 }
 
+#[derive(Debug)]
 struct TweenerShared {
 	removed: AtomicBool,
 }

crates/kira/src/modulator/tweener/handle.rs

@@ -5,6 +5,7 @@ use crate::{modulator::ModulatorId, tween::Tween};
 use super::{CommandWriters, TweenerShared};
 
 /// Controls a tweener.
+#[derive(Debug)]
 pub struct TweenerHandle {
 	pub(super) id: ModulatorId,
 	pub(super) command_writers: CommandWriters,

crates/kira/src/sound/static_sound/handle.rs

@@ -10,6 +10,7 @@ use crate::{
 use super::{sound::Shared, CommandWriters};
 
 /// Controls a static sound.
+#[derive(Debug)]
 pub struct StaticSoundHandle {
 	pub(super) command_writers: CommandWriters,
 	pub(super) shared: Arc<Shared>,

crates/kira/src/sound/static_sound/sound.rs

@@ -296,6 +296,7 @@ impl Sound for StaticSound {
 	}
 }
 
+#[derive(Debug)]
 pub(super) struct Shared {
 	state: AtomicU8,
 	position: AtomicU64,

crates/kira/src/sound/streaming.rs

@@ -44,6 +44,7 @@ use crate::{
 
 use super::{PlaybackRate, Region};
 
+#[derive(Debug)]
 pub(crate) struct CommandWriters {
 	set_volume: CommandWriter<ValueChangeCommand<Volume>>,
 	set_playback_rate: CommandWriter<ValueChangeCommand<PlaybackRate>>,
@@ -65,6 +66,7 @@ pub(crate) struct CommandReaders {
 	stop: CommandReader<Tween>,
 }
 
+#[derive(Debug)]
 pub(crate) struct DecodeSchedulerCommandReaders {
 	set_loop_region: CommandReader<Option<Region>>,
 	seek_by: CommandReader<f64>,

crates/kira/src/sound/streaming/handle.rs

@@ -1,4 +1,7 @@
-use std::sync::Arc;
+use std::{
+	fmt::{Debug, Formatter},
+	sync::Arc,
+};
 
 use crate::{
 	command::handle_param_setters,
@@ -308,3 +311,21 @@ impl<Error> StreamingSoundHandle<Error> {
 		self.error_consumer.pop()
 	}
 }
+
+impl<Error: Debug> Debug for StreamingSoundHandle<Error> {
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		f.debug_struct("StreamingSoundHandle")
+			.field("shared", &self.shared)
+			.field("command_writers", &self.command_writers)
+			.field("error_consumer", &HeapConsumerDebug)
+			.finish()
+	}
+}
+
+struct HeapConsumerDebug;
+
+impl Debug for HeapConsumerDebug {
+	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+		f.debug_struct("HeapConsumer").finish()
+	}
+}

crates/kira/src/sound/streaming/sound.rs

@@ -26,6 +26,7 @@ use super::{CommandReaders, StreamingSoundSettings};
 
 use self::decode_scheduler::DecodeScheduler;
 
+#[derive(Debug)]
 pub(crate) struct Shared {
 	state: AtomicU8,
 	position: AtomicU64,

crates/kira/src/spatial/emitter.rs

@@ -150,6 +150,7 @@ impl EmitterId {
 	}
 }
 
+#[derive(Debug)]
 pub(crate) struct EmitterShared {
 	removed: AtomicBool,
 }

crates/kira/src/spatial/emitter/handle.rs

@@ -11,6 +11,7 @@ use super::{CommandWriters, EmitterId, EmitterShared};
 ///
 /// When a [`EmitterHandle`] is dropped, the corresponding
 /// emitter will be removed.
+#[derive(Debug)]
 pub struct EmitterHandle {
 	pub(crate) id: EmitterId,
 	pub(crate) shared: Arc<EmitterShared>,

crates/kira/src/spatial/listener.rs

@@ -148,6 +148,7 @@ impl Listener {
 	}
 }
 
+#[derive(Debug)]
 pub(crate) struct ListenerShared {
 	removed: AtomicBool,
 }

crates/kira/src/spatial/listener/handle.rs

@@ -11,6 +11,7 @@ use super::{CommandWriters, ListenerShared};
 ///
 /// When a [`ListenerHandle`] is dropped, the corresponding
 /// listener will be removed.
+#[derive(Debug)]
 pub struct ListenerHandle {
 	pub(crate) shared: Arc<ListenerShared>,
 	pub(crate) command_writers: CommandWriters,

crates/kira/src/spatial/scene.rs

@@ -102,6 +102,7 @@ impl SpatialScene {
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub struct SpatialSceneId(pub(crate) Key);
 
+#[derive(Debug)]
 pub(crate) struct SpatialSceneShared {
 	removed: AtomicBool,
 }

crates/kira/src/spatial/scene/handle.rs

@@ -19,6 +19,7 @@ use super::{SpatialSceneId, SpatialSceneShared};
 ///
 /// When a [`SpatialSceneHandle`] is dropped, the corresponding
 /// spatial scene will be removed.
+#[derive(Debug)]
 pub struct SpatialSceneHandle {
 	pub(crate) id: SpatialSceneId,
 	pub(crate) shared: Arc<SpatialSceneShared>,

crates/kira/src/track.rs

@@ -302,6 +302,7 @@ impl From<&TrackHandle> for TrackId {
 	}
 }
 
+#[derive(Debug)]
 pub(crate) struct TrackShared {
 	removed: AtomicBool,
 }

crates/kira/src/track/handle.rs

@@ -25,6 +25,7 @@ impl Error for NonexistentRoute {}
 ///
 /// When a [`TrackHandle`] is dropped, the corresponding mixer
 /// track will be removed.
+#[derive(Debug)]
 pub struct TrackHandle {
 	pub(crate) id: TrackId,
 	pub(crate) shared: Option<Arc<TrackShared>>,