name_locker 0.1.1

This crate provides interface for asynchronous name lockers, that can run an async task with lock on a given name.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! I define a void implementation of [`NameLocker`].
//!

use std::{hash::Hash, marker::PhantomData};

use futures::{future::BoxFuture, stream::BoxStream};

use crate::{LockKind, NameLocker};

/// An implementation of [`NameLocker`] that doesn't apply any locking.
#[derive(Debug, Default, Clone)]
pub struct VoidNameLocker<Name> {
    _phantom: PhantomData<fn(Name)>,
}

impl<Name> NameLocker for VoidNameLocker<Name>
where
    Name: Ord + Hash + Clone + Send + Sync + 'static,
{
    type Name = Name;

    fn poll_with_lock<Output, Task>(
        &self,
        task: Task,
        _name: Option<Self::Name>,
        _lock_kind: LockKind,
    ) -> BoxFuture<'static, Output>
    where
        Task: futures::Future<Output = Output> + Send + 'static,
    {
        Box::pin(task)
    }

    #[inline]
    fn poll_read_with_lock<'s, S>(
        &self,
        stream: S,
        _name: Option<Self::Name>,
        _lock_kind: LockKind,
    ) -> BoxStream<'s, S::Item>
    where
        S: futures::Stream + Send + 's,
        <S as futures::Stream>::Item: Send,
    {
        Box::pin(stream)
    }
}