pub struct RadioStation<Value, Channel>where
Channel: RadioChannel<Value>,
Value: 'static,{ /* private fields */ }Expand description
The central hub for global state management in Freya applications.
A RadioStation holds the global state value and manages subscriptions to different channels.
Components can subscribe to specific channels to receive notifications when the state changes.
RadioStations can be shared across multiple windows or components using use_share_radio.
§Examples
§Basic usage
#[derive(Default)]
struct AppState {
count: i32,
}
#[derive(PartialEq, Eq, Clone, Debug, Copy, Hash)]
enum AppChannel {
Count,
}
impl RadioChannel<AppState> for AppChannel {}
fn app() -> impl IntoElement {
// Create a radio station (scoped to this component tree)
use_init_radio_station::<AppState, AppChannel>(AppState::default);
let mut radio = use_radio(AppChannel::Count);
rect()
.child(label().text(format!("Count: {}", radio.read().count)))
.child(
Button::new()
.on_press(move |_| radio.write().count += 1)
.child("Increment"),
)
}§Global radio station for multi-window apps
let radio_station = RadioStation::create_global(AppState::default);
launch(
LaunchConfig::new()
.with_window(WindowConfig::new(Window1 { radio_station }))
.with_window(WindowConfig::new(Window2 { radio_station })),
);Implementations§
Source§impl<Value, Channel> RadioStation<Value, Channel>where
Channel: RadioChannel<Value>,
impl<Value, Channel> RadioStation<Value, Channel>where
Channel: RadioChannel<Value>,
Sourcepub fn create_global(init_value: Value) -> Self
pub fn create_global(init_value: Value) -> Self
Create a global RadioStation that lives for the entire application lifetime.
This is useful for sharing state across multiple windows.
You would usually want to call this in your main function, not anywhere else.
§Example
let radio_station = RadioStation::create_global(AppState::default);
launch(
LaunchConfig::new()
.with_window(WindowConfig::new(Window1 { radio_station }))
.with_window(WindowConfig::new(Window2 { radio_station })),
);Sourcepub fn write_channel(&mut self, channel: Channel) -> RadioGuard<Value, Channel>
pub fn write_channel(&mut self, channel: Channel) -> RadioGuard<Value, Channel>
Modify the state using a specific channel. This will notify all subscribers to that channel (and any derived channels).
Returns a RadioGuard that allows direct mutation of the state.
The guard automatically notifies listeners when dropped.
§Example
radio_station.write_channel(MyChannel::Update).count += 1;Trait Implementations§
Source§impl<Value, Channel> Clone for RadioStation<Value, Channel>where
Channel: RadioChannel<Value>,
impl<Value, Channel> Clone for RadioStation<Value, Channel>where
Channel: RadioChannel<Value>,
impl<Value, Channel> Copy for RadioStation<Value, Channel>where
Channel: RadioChannel<Value>,
Auto Trait Implementations§
impl<Value, Channel> Freeze for RadioStation<Value, Channel>
impl<Value, Channel> !RefUnwindSafe for RadioStation<Value, Channel>
impl<Value, Channel> !Send for RadioStation<Value, Channel>
impl<Value, Channel> !Sync for RadioStation<Value, Channel>
impl<Value, Channel> Unpin for RadioStation<Value, Channel>
impl<Value, Channel> !UnwindSafe for RadioStation<Value, Channel>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more