Struct RadioStation 

pub struct RadioStation<Value, Channel>
where
    Channel: RadioChannel<Value>,
    Value: 'static,
{ /* private fields */ }

Available on crate feature radio only.

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

impl<Value, Channel> RadioStation<Value, Channel>

where Channel: RadioChannel<Value>,

pub fn create_global(init_value: Value) -> RadioStation<Value, Channel>

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 })),
);

pub fn read(&self) -> <UnsyncStorage as AnyStorage>::Ref<'_, Value>

Read the current state value and subscribe to all channel changes. Any component calling this will re-render when any channel is notified.

Example

let value = radio_station.read();

pub fn peek(&self) -> <UnsyncStorage as AnyStorage>::Ref<'_, Value>

Read the current state value without subscribing to changes. Components using this will not re-render when the state changes.

Example

let value = radio_station.peek();

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

impl<Value, Channel> Clone for RadioStation<Value, Channel>

where Channel: RadioChannel<Value>,

fn clone(&self) -> RadioStation<Value, Channel>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Value, Channel> Copy for RadioStation<Value, Channel>

where Channel: RadioChannel<Value>,