join_impl 0.3.0

Implementation of the `join!` macro.
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

//!
//! Generic chain with all kinds of expressions, groups etc.
//!

pub mod expr;
pub mod group;
pub mod parse_chain;
pub use parse_chain::ParseChain;

///
/// Any chain with members of type `Member` and optional `Identifier`.
///
pub trait Chain
where
    Self: Sized,
{
    type Member: Sized;
    type Identifier: Sized;

    ///
    /// Constructs new Chain.
    ///
    fn new(id: impl Into<Option<Self::Identifier>>, members: &[Self::Member]) -> Self;

    ///
    /// Adds member to chain.
    ///
    fn append_member(&mut self, member: Self::Member) -> usize;

    ///
    /// Removes member from chain.
    ///
    fn remove_member(&mut self, idx: usize) -> Option<Self::Member>;

    ///
    /// Returns self members.
    ///
    fn members(&self) -> &[Self::Member];

    ///
    /// Returns chain length.
    ///
    fn len(&self) -> usize;

    ///
    /// Checks if chain is empty.
    ///
    fn is_empty(&self) -> bool {
        self.len() == 0
    }

    ///
    /// Sets chain identifier.
    ///
    fn set_id(&mut self, id: impl Into<Option<Self::Identifier>>) -> &mut Self;

    ///
    /// Returns optional `Identifier` associated with chain.
    ///
    fn id(&self) -> Option<&Self::Identifier>;
}