Skip to main content

VfdWorker

Struct VfdWorker 

Source
pub struct VfdWorker<T: Write + Send + 'static = Box<dyn SerialPort>> { /* private fields */ }
Expand description

Владеет фоновым потоком записи.

Предпочитайте явный VfdWorker::shutdown, чтобы дождаться завершения потока и вернуть внутренний драйвер. Drop предназначен только для аварийного закрытия забытых worker-ов и игнорирует ошибку завершения.

Implementations§

Source§

impl VfdWorker<Box<dyn SerialPort>>

Source

pub fn start(cfg: VfdConfig) -> Result<Self>

Открывает дисплей и запускает поток последовательной обработки команд.

§Блокировка

Метод блокирует текущий поток на открытии serial-порта и init-записи, затем создаёт отдельный поток writer-а.

§Ошибки

Возвращает ошибки конфигурации, serial open или init I/O из crate::Vfd::open.

Source§

impl<T: Write + Send + 'static> VfdWorker<T>

Source

pub fn from_vfd(vfd: Vfd<T>, queue_capacity: usize) -> Result<Self>

Запускает worker поверх уже созданного драйвера.

Worker сначала очищает дисплей, затем начинает принимать команды. Ошибка первой очистки завершит поток и вернётся ожидающему shutdown.

§Ошибки

Возвращает VfdError::Config, если queue_capacity = 0.

Source

pub fn from_transport( transport: T, display: DisplaySettings, queue_capacity: usize, ) -> Result<Self>

Запускает worker поверх произвольного транспорта.

Метод удобен для тестов и интеграций с собственным транспортом. Init-команды записываются до запуска worker-потока.

§Ошибки

Возвращает ошибки crate::Vfd::from_transport или VfdError::Config при queue_capacity = 0.

Source

pub fn handle(&self) -> VfdHandle

Возвращает новый клон интерфейса отправки команд.

Клон можно хранить отдельно от VfdWorker. Сам worker всё равно должен жить дольше handle-ов, иначе команды начнут возвращать ошибки очереди.

Source

pub fn shutdown(self) -> Result<Vfd<T>>

Корректно останавливает worker и возвращает драйвер с транспортом.

Shutdown-команда обрабатывается после ранее принятых команд. После этого очередь больше не используется, а join result возвращает накопленную ошибку worker-а.

§Ошибки

Возвращает ошибку отправки shutdown, последнюю ошибку worker-а или VfdError::WorkerPanicked, если поток завершился panic-ом.

Trait Implementations§

Source§

impl<T: Write + Send + 'static> Drop for VfdWorker<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<T = Box<dyn SerialPort>> !RefUnwindSafe for VfdWorker<T>

§

impl<T = Box<dyn SerialPort>> !UnwindSafe for VfdWorker<T>

§

impl<T> Freeze for VfdWorker<T>

§

impl<T> Send for VfdWorker<T>

§

impl<T> Sync for VfdWorker<T>

§

impl<T> Unpin for VfdWorker<T>

§

impl<T> UnsafeUnpin for VfdWorker<T>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.