interprocess-docfix 1.2.2

Interprocess communication toolkit. Docs fixed.
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

use {super::Xorshift32, interprocess::local_socket::NameTypeSupport};
#[derive(Copy, Clone, Debug)]
pub struct NameGen {
    rng: Xorshift32,
    namespaced: bool,
}
impl NameGen {
    pub fn new(namespaced: bool) -> Self {
        Self {
            rng: Xorshift32::from_system_time(),
            namespaced,
        }
    }
    /// Automatically chooses name type based on OS support and preference.
    pub fn new_auto(prefer_namespaced: bool) -> Self {
        let namespaced = {
            use NameTypeSupport::*;
            let nts = NameTypeSupport::query();
            match (nts, prefer_namespaced) {
                (OnlyPaths, _) | (Both, false) => false,
                (OnlyNamespaced, _) | (Both, true) => true,
            }
        };
        Self::new(namespaced)
    }
    fn next_path(&mut self) -> String {
        format!("/tmp/interprocess-test-{:08x}.sock", self.rng.next())
    }
    fn next_namespaced(&mut self) -> String {
        format!("@interprocess-test-{:08x}.sock", self.rng.next())
    }
}
impl Iterator for NameGen {
    type Item = String;
    fn next(&mut self) -> Option<Self::Item> {
        let name = match self.namespaced {
            false => self.next_path(),
            true => self.next_namespaced(),
        };
        Some(name)
    }
}