Struct SyncTui 

pub struct SyncTui { /* private fields */ }

Terminal user interface for synchronization operations.

SyncTui provides a visual interface for monitoring price data synchronization, including sync status, price ticks, and price history state. It must be coupled with a SyncEngine before synchronization begins.

Implementations

impl SyncTui

pub async fn launch( config: TuiConfig, log_file_path: Option<&str>, ) -> Result<Arc<Self>, TuiError>

Launches a new sync TUI with the specified configuration.

Optionally writes TUI logs to a file if log_file_path is provided.

pub fn status(&self) -> TuiStatus

Returns the current TuiStatus as a snapshot.

pub fn couple(&self, engine: SyncEngine) -> Result<(), TuiError>

Couples a SyncEngine to this TUI instance.

This method starts the sync engine and begins listening for sync updates. It can only be called once per TUI instance.

Returns an error if a sync engine has already been coupled.

pub async fn shutdown(&self) -> Result<(), TuiError>

Performs a graceful shutdown of the sync TUI.

This method shuts down the coupled sync engine and stops the UI task. If shutdown does not complete within the configured timeout, the task is aborted.

Returns an error if the TUI is not running or if shutdown fails.

pub async fn until_stopped(&self) -> Arc<TuiStatusStopped>

Waits until the TUI has stopped and returns the final stopped status.

This method blocks until the TUI reaches a stopped state, either through graceful shutdown or a crash.

The terminal is automatically restored before this method returns.

pub async fn log(&self, text: String) -> Result<(), TuiError>

Logs a message to the TUI.

Returns an error if the TUI is not running or if sending the log entry fails.

pub fn as_logger(self: &Arc<Self>) -> Arc<dyn TuiLogger>

Returns this TUI as a TuiLogger trait object.

This is useful for passing the TUI to components that accept a generic logger.

Trait Implementations

impl Drop for SyncTui

fn drop(&mut self)

Executes the destructor for this type.

impl TuiLogger for SyncTui

fn log<'life0, 'async_trait>( &'life0 self, log_entry: String, ) -> Pin<Box<dyn Future<Output = Result<(), TuiError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a log entry to the TUI for display.