Структура SetOnce
pub struct SetOnce<T> { /* private fields */ }sync.Потокобезопасная ячейка, в которую можно записать значение только один раз.
SetOnce вдохновлён типом asyncio.Event из Python. Его можно использовать, чтобы ожидать установки значения SetOnce, подобно механизму «события».
Пример
use tokio::sync::{SetOnce, SetOnceError};
static ONCE: SetOnce<u32> = SetOnce::const_new();
// set the value inside a task somewhere...
tokio::spawn(async move { ONCE.set(20) });
// checking with .get doesn't block main thread
println!("{:?}", ONCE.get());
// wait until the value is set, blocks the thread
println!("{:?}", ONCE.wait().await);
Ok(())SetOnce обычно используется для глобальных переменных, которые нужно инициализировать при первом использовании, но которые больше не требуется изменять. SetOnce в Tokio позволяет выполнять процедуру инициализации асинхронно.
Пример
use tokio::sync::{SetOnce, SetOnceError};
use std::sync::Arc;
let once = SetOnce::new();
let arc = Arc::new(once);
let first_cl = Arc::clone(&arc);
let second_cl = Arc::clone(&arc);
// set the value inside a task
tokio::spawn(async move { first_cl.set(20) }).await.unwrap()?;
// wait inside task to not block the main thread
tokio::spawn(async move {
// wait inside async context for the value to be set
assert_eq!(*second_cl.wait().await, 20);
}).await.unwrap();
// subsequent set calls will fail
assert!(arc.set(30).is_err());
println!("{:?}", arc.get());
Ok(())Реализации
impl<T> SetOnce<T>
pub fn new() -> Self
Создаёт новый пустой экземпляр SetOnce.
pub const fn const_new() -> Self
Создаёт новый пустой экземпляр SetOnce.
Эквивалентен SetOnce::new, но может использоваться в статических переменных.
При использовании нестабильной функции tracing нестабильная функция объект SetOnce, созданный с помощью const_new, не будет инструментирован. Поэтому он не будет виден в tokio-console. Если требуется инструментированный объект, для его создания следует использовать SetOnce::new.
Пример
use tokio::sync::{SetOnce, SetOnceError};
static ONCE: SetOnce<u32> = SetOnce::const_new();
fn get_global_integer() -> Result<Option<&'static u32>, SetOnceError<u32>> {
ONCE.set(2)?;
Ok(ONCE.get())
}
let result = get_global_integer()?;
assert_eq!(result, Some(&2));
Ok(())pub fn new_with(value: Option<T>) -> Self
Создаёт новый SetOnce, содержащий переданное значение, если оно есть.
Если Option имеет значение None, это эквивалентно SetOnce::new.
pub const fn const_new_with(value: T) -> Self
Создаёт новый SetOnce, содержащий переданное значение.
Пример
При использовании нестабильной функции tracing нестабильная функция объект SetOnce, созданный с помощью const_new_with, не будет инструментирован. Поэтому он не будет виден в tokio-console. Если требуется инструментированный объект, для его создания следует использовать SetOnce::new_with.
use tokio::sync::SetOnce;
static ONCE: SetOnce<u32> = SetOnce::const_new_with(1);
fn get_global_integer() -> Option<&'static u32> {
ONCE.get()
}
let result = get_global_integer();
assert_eq!(result, Some(&1));pub fn initialized(&self) -> bool
Возвращает true, если SetOnce в данный момент содержит значение, и false в противном случае.
pub fn get(&self) -> Option<&T>
Возвращает ссылку на значение, хранящееся в SetOnce, или None, если SetOnce пуста.
pub fn set(&self, value: T) -> Result<(), SetOnceError<T>>
Устанавливает для SetOnce переданное значение, если SetOnce пуста.
Если SetOnce уже содержит значение, этот вызов завершится ошибкой SetOnceError.
pub fn into_inner(self) -> Option<T>
Извлекает значение из ячейки, уничтожая её. Возвращает None, если ячейка пуста.
Реализации трейтов
impl<T: Eq> Eq for SetOnce<T>
impl<T: Send> Send for SetOnce<T>
impl<T: Sync + Send> Sync for SetOnce<T>
Реализации авто-трейтов
impl<T> !Freeze for SetOnce<T>
impl<T> !RefUnwindSafe for SetOnce<T>
impl<T> Unpin for SetOnce<T>where T: Unpin,
impl<T> UnsafeUnpin for SetOnce<T>where T: UnsafeUnpin,
impl<T> UnwindSafe for SetOnce<T>where T: UnwindSafe,
Универсальные реализации
impl<T> BorrowMut<T> for Twhere T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
impl<T> CloneToUninit for Twhere T: Clone,
unsafe fn clone_to_uninit(&self, dest: *mut u8)
clone_to_uninit)
impl<T> Instrument for T
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> ToOwned for Twhere T: Clone,
type Owned = T
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)
impl<T> WithSubscriber for T
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
Subscriber к этому типу и возвращает обёртку WithDispatch. Подробнее
MIT License
Copyright © Tokio Contributors
https://docs.rs/tokio/1.53.1/tokio/sync/struct.SetOnce.html
