Skip to main content

AppState

Struct AppState 

Source
pub struct AppState {
Show 13 fields pub port_path: Arc<Mutex<String>>, pub baud_rate: u32, pub serial_connected: Arc<AtomicBool>, pub collection_running: Arc<AtomicBool>, pub cmd_tx: Sender<String>, pub csi_tx: Sender<Vec<u8>>, pub log_mode_tx: Arc<Sender<LogMode>>, pub output_mode_tx: Arc<Sender<OutputMode>>, pub session_file_tx: Arc<Sender<Option<String>>>, pub config: Arc<Mutex<DeviceConfig>>, pub info_request_tx: Sender<InfoResponder>, pub firmware_verified: Arc<AtomicBool>, pub device_info: Arc<Mutex<Option<DeviceInfo>>>,
}
Expand description

Shared application state, cheaply cloned into every route handler via Axum’s State extractor.

Fields§

§port_path: Arc<Mutex<String>>

USB serial port path used to reach the ESP32 (e.g. /dev/ttyUSB0). Stored so route handlers can open a short-lived second fd for control operations such as RTS-triggered reset.

§baud_rate: u32

Baud rate negotiated at startup. The serial task and the RTS-reset handler both read this so a single source of truth governs the link.

§serial_connected: Arc<AtomicBool>

Whether the serial task currently has an open and healthy ESP32 link.

§collection_running: Arc<AtomicBool>

Best-effort flag: true after successful start, false after reset/disconnect.

§cmd_tx: Sender<String>

Send CLI command strings to the serial background task.

§csi_tx: Sender<Vec<u8>>

Broadcast raw CSI frame bytes to all connected WebSocket clients.

§log_mode_tx: Arc<Sender<LogMode>>

Notify the serial task of log-mode changes (affects the frame delimiter).

§output_mode_tx: Arc<Sender<OutputMode>>

Notify the serial task of output-mode changes (stream / dump / both).

§session_file_tx: Arc<Sender<Option<String>>>

Signal the serial task of the current session’s dump file path. Some(path) → open/reuse that file; None → session ended, close file.

§config: Arc<Mutex<DeviceConfig>>

Cached view of the current device configuration.

§info_request_tx: Sender<InfoResponder>

Issue an info command on the device and capture the magic block. The serial task synchronously consumes the responder.

§firmware_verified: Arc<AtomicBool>

true once the serial task (or an explicit /api/info call) has observed a valid ESP-CSI-CLI/<version> magic block from the device. Cleared on disconnect, on POST /api/control/reset (until the post-reset re-verification completes), and on a failed verification. Command endpoints refuse to send while this is false.

§device_info: Arc<Mutex<Option<DeviceInfo>>>

Last successfully parsed firmware identification block. None until the first verification succeeds; cleared alongside firmware_verified.

Implementations§

Source§

impl AppState

Source

pub fn require_firmware(&self) -> Option<(StatusCode, Json<ApiResponse>)>

Returns an early-return tuple suitable for handlers when the firmware has not yet been verified as esp-csi-cli-rs. Use this to short-circuit any endpoint that issues a CLI command — sending commands to an unverified device may interact with whatever bootloader/firmware is listening in unintended ways.

Trait Implementations§

Source§

impl Clone for AppState

Source§

fn clone(&self) -> AppState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,