Struct GSlot

pub struct GSlot {}

An interface for providing Dora SSR built-in global event names.

Implementations

impl GSlot

pub const APP_EVENT: &'static str = "AppEvent"

Triggers when the application receives an event.

Callback Arguments

• event_type: string - The type of the application event. The event type could be “Quit”, “LowMemory”, “WillEnterBackground”, “DidEnterBackground”, “WillEnterForeground”, “DidEnterForeground”.

Callback Example

node.gslot(GSlot::APP_EVENT, Box::new(|stack| {
	let event_type = match stack.pop_str() {
		Some(event_type) => event_type,
		None => return,
	};
	p!(event_type);
}));

pub const APP_CHANGE: &'static str = "AppChange"

Triggers when the application settings change.

Callback Arguments

• setting_name: string - The name of the setting that changed. Could be “Locale”, “Theme”, “FullScreen”, “Position”, “Size”.

Callback Example

node.gslot(GSlot::APP_CHANGE, Box::new(|stack| {
	let setting_name = match stack.pop_str() {
		Some(setting_name) => setting_name,
		None => return,
	};
	p!(setting_name);
}));

pub const APP_WS: &'static str = "AppWS"

Triggers when gets an event from a websocket connection.

Callback Arguments

• event_type: string - The event type of the message received. Could be “Open”, “Close”, “Send”, “Receive”.
• msg: string - The message received.

Callback Example

node.gslot(GSlot::APP_WS, Box::new(|stack| {
	let (
		event_type,
		msg
	) = match (stack.pop_str(), stack.pop_str()) {
		(Some(event_type), Some(msg)) => (event_type, msg),
		_ => return,
	};
	p!(event_type, msg);
}));

pub fn on_app_event<F>(node: &mut dyn INode, callback: F)

where F: FnMut(String) + 'static,

Registers a callback for event triggered when the application receives an event.

Arguments

• node: &mut dyn INode - The node to register the callback on.
• callback: F - The callback to be called when the event is triggered with the following arguments:
  • event_type: String - The type of the application event. The event type could be “Quit”, “LowMemory”, “WillEnterBackground”, “DidEnterBackground”, “WillEnterForeground”, “DidEnterForeground”.

pub fn on_app_change<F>(node: &mut dyn INode, callback: F)

where F: FnMut(String) + 'static,

Registers a callback for event triggered when the application settings change.

Arguments

• node: &mut dyn INode - The node to register the callback on.
• callback: F - The callback to be called when the event is triggered with the following arguments:
  • setting_name: String - The name of the setting that changed. Could be “Locale”, “Theme”, “FullScreen”, “Position”, “Size”.

pub fn on_app_ws<F>(node: &mut dyn INode, callback: F)

where F: FnMut(String, String) + 'static,

Registers a callback for event triggered when gets an event from a websocket connection.

Arguments

• node: &mut dyn INode - The node to register the callback on.
• callback: F - The callback to be called when the event is triggered with the following arguments:
  • event_type: String - The event type of the message received. Could be “Open”, “Close”, “Send”, “Receive”.
  • msg: String - The message received.