devela_base_std 0.26.0

base std shared functionality for devela
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

// devela_base_std::work::thread::_reexport
//
//!
//
// Note that std's standalone functions are namespaced in `devela::ThreadExt`.

use crate::{
    _TAG_CODE, _TAG_CONCURRENCY, _TAG_CONSTRUCTION, _TAG_ERROR, _TAG_RESULT, _TAG_UID, _reexport,
};

/* types */

_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!() _TAG_ERROR!(),
    doc: "An error returned by [`ThreadLocalKey::try_with`].",
    @AccessError as ThreadAccessError
}
_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONSTRUCTION!() _TAG_CONCURRENCY!(),
    doc: "Thread factory, which can be used to configure the properties of a new thread.",
    @Builder as ThreadBuilder
}
_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!(),
    doc: "An owned permission to join on a thread (block on its termination).",
    @JoinHandle as ThreadJoinHandle
}
_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!(),
    doc: "A thread local storage key which owns its contents.",
    @LocalKey as ThreadLocalKey
}
_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!(),
    doc: "A scope to spawn scoped threads in.",
    @Scope as ThreadScope
}
_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!(),
    doc: "An owned permission to join on a scoped thread (block on its termination).",
    @ScopedJoinHandle as ThreadScopedJoinHandle
}
_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!() _TAG_UID!(),
    doc: "A handle to a thread.",
    +doc: "See also the [`ThreadExt`][crate::ThreadExt] trait.",
    Thread
}
_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!() _TAG_UID!(),
    doc: "A unique identifier for a running thread.",
    ThreadId
}

/* macros */

_reexport! { rust: std,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!() _TAG_CODE!(),
    doc: "Declare a new thread local storage key of type [`ThreadLocalKey`].",
    thread_local
}

/* aliases */

_reexport! { rust: std::thread,
    location: "work/thread",
    tag: _TAG_CONCURRENCY!() _TAG_RESULT!(),
    doc: "A specialized [`Result`] type for threads.",
    @Result as ThreadResult
}