Mountain/ApplicationState/State/FeatureState/OutputChannels/
OutputChannelState.rs

1//! # OutputChannelState Module (ApplicationState)
2//!
3//! ## RESPONSIBILITIES
4//! Manages output channel state including output metadata, content, and
5//! presentation state.
6//!
7//! ## ARCHITECTURAL ROLE
8//! OutputChannelState is part of the **FeatureState** module, representing
9//! output channel state organized by channel ID.
10//!
11//! ## KEY COMPONENTS
12//! - OutputChannelState: Main struct containing output channels map
13//! - Default: Initialization implementation
14//! - Helper methods: Output channel manipulation utilities
15//!
16//! ## ERROR HANDLING
17//! - Thread-safe access via `Arc<Mutex<...>>`
18//! - Proper lock error handling with `MapLockError` helpers
19//!
20//! ## LOGGING
21//! State changes are logged at appropriate levels (debug, info, warn, error).
22//!
23//! ## PERFORMANCE CONSIDERATIONS
24//! - Lock mutexes briefly and release immediately
25//! - Avoid nested locks to prevent deadlocks
26//! - Use Arc for shared ownership across threads
27//!
28//! ## TODO
29//! - [ ] Add output channel validation invariants
30//! - [ ] Implement output channel lifecycle events
31//! - [ ] Add output channel metrics collection
32
33use std::{
34	collections::HashMap,
35	sync::{Arc, Mutex as StandardMutex},
36};
37
38use log::debug;
39
40use crate::ApplicationState::DTO::OutputChannelStateDTO::OutputChannelStateDTO;
41
42/// Output channels state containing channels by ID.
43#[derive(Clone)]
44pub struct OutputChannelState {
45	/// Output channels organized by ID.
46	pub OutputChannels:Arc<StandardMutex<HashMap<String, OutputChannelStateDTO>>>,
47}
48
49impl Default for OutputChannelState {
50	fn default() -> Self {
51		debug!("[OutputChannelState] Initializing default output channel state...");
52
53		Self { OutputChannels:Arc::new(StandardMutex::new(HashMap::new())) }
54	}
55}
56
57impl OutputChannelState {
58	/// Gets all output channels.
59	pub fn GetAll(&self) -> HashMap<String, OutputChannelStateDTO> {
60		self.OutputChannels.lock().ok().map(|guard| guard.clone()).unwrap_or_default()
61	}
62
63	/// Gets an output channel by its ID.
64	pub fn Get(&self, id:&str) -> Option<OutputChannelStateDTO> {
65		self.OutputChannels.lock().ok().and_then(|guard| guard.get(id).cloned())
66	}
67
68	/// Adds or updates an output channel.
69	pub fn AddOrUpdate(&self, id:String, channel:OutputChannelStateDTO) {
70		if let Ok(mut guard) = self.OutputChannels.lock() {
71			guard.insert(id, channel);
72			debug!("[OutputChannelState] Output channel added/updated");
73		}
74	}
75
76	/// Removes an output channel by its ID.
77	pub fn Remove(&self, id:&str) {
78		if let Ok(mut guard) = self.OutputChannels.lock() {
79			guard.remove(id);
80			debug!("[OutputChannelState] Output channel removed: {}", id);
81		}
82	}
83
84	/// Clears all output channels.
85	pub fn Clear(&self) {
86		if let Ok(mut guard) = self.OutputChannels.lock() {
87			guard.clear();
88			debug!("[OutputChannelState] All output channels cleared");
89		}
90	}
91
92	/// Gets the count of output channels.
93	pub fn Count(&self) -> usize { self.OutputChannels.lock().ok().map(|guard| guard.len()).unwrap_or(0) }
94
95	/// Checks if an output channel exists.
96	pub fn Contains(&self, id:&str) -> bool {
97		self.OutputChannels
98			.lock()
99			.ok()
100			.map(|guard| guard.contains_key(id))
101			.unwrap_or(false)
102	}
103}