Spec-Zone.ru › Tokio

Структура CtrlClose

pub struct CtrlClose { /* private fields */ }
Доступно только в Windows и при включённой функции crate signal.

Представляет обработчик, получающий уведомления «ctrl-close», отправленные процессу через SetConsoleCtrlHandler.

Уведомление этому процессу оповещает всех обработчиков, ожидающих это событие. Кроме того, уведомления объединяются, если они не обрабатываются достаточно быстро. Это означает, что если два уведомления получены одно за другим, обработчик может получить только один элемент для обоих уведомлений.

Реализации

impl CtrlClose

pub async fn recv(&mut self) -> Option<()>

Получает следующее событие уведомления о сигнале.

Хотя этот метод возвращает Option<()>, на самом деле он никогда не вернёт None. Эта возможность была раскрыта случайно, и её удаление стало бы ломающим изменением.

Примеры
use tokio::signal::windows::ctrl_close;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // A listener of CTRL-CLOSE events.
    let mut signal = ctrl_close()?;

    // Print whenever a CTRL-CLOSE event is received.
    signal.recv().await;
    println!("got CTRL-CLOSE. Cleaning up before exiting");

    Ok(())
}

pub fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll<Option<()>>

Проверяет возможность получить следующее событие уведомления о сигнале вне контекста async.

Хотя этот метод возвращает Option<()>, на самом деле он никогда не вернёт None. Эта возможность была раскрыта случайно, и её удаление стало бы ломающим изменением.

Примеры

Опрос из вручную реализованного future

use std::pin::Pin;
use std::future::Future;
use std::task::{Context, Poll};
use tokio::signal::windows::CtrlClose;

struct MyFuture {
    ctrl_close: CtrlClose,
}

impl Future for MyFuture {
    type Output = Option<()>;

    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        println!("polling MyFuture");
        self.ctrl_close.poll_recv(cx)
    }
}

Реализации трейтов

impl Debug for CtrlClose

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Форматирует значение с помощью заданного форматировщика. Подробнее

Реализации авто-трейтов

impl !RefUnwindSafe for CtrlClose

impl !UnwindSafe for CtrlClose

impl Freeze for CtrlClose

impl Send for CtrlClose

impl Sync for CtrlClose

impl Unpin for CtrlClose

impl UnsafeUnpin for CtrlClose

Общие реализации

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

fn type_id(&self) -> TypeId

Получает TypeId для self. Подробнее

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

fn borrow(&self) -> &T

Неизменяемо заимствует данные из принадлежащего значения. Подробнее

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

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

Изменяемо заимствует данные из принадлежащего значения. Подробнее

impl<T> From<T> for T

fn from(t: T) -> T

Возвращает аргумент без изменений.

impl<T> Instrument for T

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

Инструментирует этот тип с помощью указанного Span, возвращая обёртку Instrumented. Подробнее

fn in_current_span(self) -> Instrumented<Self> ⓘ

Инструментирует этот тип с помощью текущего Span, возвращая обёртку Instrumented. Подробнее

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

fn into(self) -> U

Вызывает U::from(self).

То есть это преобразование выполняет действие, определяемое реализацией From<T> for U.

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

type Error = Infallible

Тип, возвращаемый в случае ошибки преобразования.

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

Выполняет преобразование.

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

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

Тип, возвращаемый в случае ошибки преобразования.

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

Выполняет преобразование.

impl<T> WithSubscriber for T

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

Присоединяет переданный Subscriber к этому типу и возвращает обёртку WithDispatch. Подробнее

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Присоединяет текущий по умолчанию Subscriber к этому типу и возвращает обёртку WithDispatch. Подробнее

MIT License
Copyright © Tokio Contributors
https://docs.rs/tokio/1.53.1/tokio/signal/windows/struct.CtrlClose.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API