scsys-core 0.2.0-alpha

scsys lays the foundation for the Scattered-Systems ecosystem, delivering critical primitives throughout
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

/*
    Appellation: specs <module>
    Contrib: FL03 <jo3mccain@icloud.com>
*/
//! # Specs
//! 
//! 

pub mod appellation;
pub mod classify;


/// Interface for data-structures that can be compared for equality
pub trait Contain<T>
where
    T: PartialEq,
{
    /// [Contain::contains] returns true if the given element is in the [Contain] instance
    fn contains(&self, elem: &T) -> bool;
    /// [Contain::contains_all] returns true if all elements in the given iterator are in the [Contain] instance
    fn contains_all(&self, iter: impl IntoIterator<Item = T>) -> bool {
        iter.into_iter().all(|i| self.contains(&i))
    }
    /// [Contain::contains_some] returns true if any element in the given iterator is in the [Contain] instance
    fn contains_some(&self, iter: impl IntoIterator<Item = T>) -> bool {
        iter.into_iter().any(|i| self.contains(&i))
    }
}

/// Interface for nameable data-structures
pub trait Name {
    fn name(&self) -> String;
    fn slug(&self) -> String {
        self.name().to_lowercase().replace(" ", "-")
    }
}


pub(crate) mod prelude {
    pub use super::{Contain, Name};
    pub use super::appellation::*;
    pub use super::classify::*;
}