ninja-writer 0.3.1

Simple and ergonomic library for writing Ninja build files
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

//! Implementation of variables

use alloc::string::String;
use core::fmt::{Display, Formatter, Result};

use crate::ToArg;

/// A variable declaration (`name = value`)
///
/// See <https://ninja-build.org/manual.html#_variables>
///
/// # Escaping
/// Escaping must be done when constructing the variable. No escaping is done when serializing.
/// ```rust
/// use ninja_writer::Variable;
///
/// let var = Variable::new("foo", "I have a $ in me");
///
/// assert_eq!(var.to_string(), "foo = I have a $ in me");
/// ```
#[derive(Debug, Clone, PartialEq, Default)]
pub struct Variable {
    /// The name of the variable
    pub name: String,
    /// The value of the variable
    pub value: String,
}

impl Variable {
    /// Create a new variable declaration
    pub fn new(name: impl ToArg, value: impl ToArg) -> Self {
        Self {
            name: name.to_arg(),
            value: value.to_arg(),
        }
    }
}

impl Display for Variable {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        write!(f, "{} = {}", self.name, self.value)
    }
}

/// Convienience trait to implement types that supports variables
pub trait Variables: Sized {
    /// Add a variable
    ///
    /// This is an internal method to add a variable to the current scope.
    fn add_variable_internal(&self, v: Variable);

    /// Add a variable to the current scope
    fn variable(self, name: impl ToArg, value: impl ToArg) -> Self {
        self.add_variable_internal(Variable::new(name, value));
        self
    }
}