cubing_core 0.15.1

Features from `cubing.js` in Rust.
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

use std::fmt;

// TODO: Remove `PartialEq` if we add any metadata (e.g. parsing info, or memoizations).
#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub struct LineComment {
    text: String,
}

impl LineComment {
    // What's the best pattern to ensure that `text` can't contain newline?
    // (`try_from` should strip the leading `//`, so it's not the same)
    pub fn try_new(s: &str) -> Result<LineComment, String> {
        if s.contains('\n') {
            return Err("Line comment cannot contain a newline.".into());
        }
        Ok(LineComment { text: s.to_owned() })
    }

    pub fn invert(&self) -> LineComment {
        self.clone()
    }

    pub fn text(&self) -> &str {
        &self.text
    }
}

impl fmt::Display for LineComment {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        // Note: does NOT include newline, in case it's the final node in an alg.
        write!(f, "//{}", self.text)
    }
}