ser_nix 0.2.1

An opinionated nix serialiser for serde.rs
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
use crate::error::Error;
use serde::{Serialize, Serializer, ser};
use std::borrow::Cow;
use std::ops::Deref;
use std::path::{Component, Path, PathBuf};

pub(crate) const TOKEN: &str = "$ser_nix::private::Path";

/// Internal serializer that emits raw strings without quoting.
pub(crate) struct RawEmitter<'a> {
    pub output: &'a mut String,
}

impl ser::Serializer for RawEmitter<'_> {
    type Ok = ();
    type Error = Error;
    type SerializeSeq = ser::Impossible<(), Error>;
    type SerializeTuple = ser::Impossible<(), Error>;
    type SerializeTupleStruct = ser::Impossible<(), Error>;
    type SerializeTupleVariant = ser::Impossible<(), Error>;
    type SerializeMap = ser::Impossible<(), Error>;
    type SerializeStruct = ser::Impossible<(), Error>;
    type SerializeStructVariant = ser::Impossible<(), Error>;

    fn serialize_str(self, v: &str) -> Result<Self::Ok, Self::Error> {
        self.output.push_str(v);
        Ok(())
    }

    fn serialize_i128(self, _v: i128) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_u128(self, _v: u128) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_bool(self, _v: bool) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_i8(self, _v: i8) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_i16(self, _v: i16) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_i32(self, _v: i32) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_i64(self, _v: i64) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_u8(self, _v: u8) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_u16(self, _v: u16) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_u32(self, _v: u32) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_u64(self, _v: u64) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_f32(self, _v: f32) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_f64(self, _v: f64) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_char(self, _v: char) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_bytes(self, _v: &[u8]) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_none(self) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_some<T: ?Sized + Serialize>(self, _value: &T) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_unit(self) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_unit_struct(self, _name: &'static str) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_unit_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        _variant: &'static str,
    ) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_newtype_struct<T: ?Sized + Serialize>(
        self,
        _name: &'static str,
        _value: &T,
    ) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_newtype_variant<T: ?Sized + Serialize>(
        self,
        _name: &'static str,
        _variant_index: u32,
        _variant: &'static str,
        _value: &T,
    ) -> Result<Self::Ok, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_seq(self, _len: Option<usize>) -> Result<Self::SerializeSeq, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_tuple_struct(
        self,
        _name: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeTupleStruct, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_tuple_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        _variant: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeTupleVariant, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_map(self, _len: Option<usize>) -> Result<Self::SerializeMap, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_struct(
        self,
        _name: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeStruct, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }

    fn serialize_struct_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        _variant: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeStructVariant, Self::Error> {
        Err(ser::Error::custom("expected string"))
    }
}

/// An owned path that serializes as a Nix path literal.
///
/// Use this wrapper type when you want a path to be serialized as a Nix path
/// literal (e.g., `./foo.nix` or `/etc/nixos/configuration.nix`).
///
/// For borrowed paths, use [`NixPath`] or `#[serde(serialize_with = "ser_nix::as_nix_path")]`.
///
/// # Example
///
/// ```
/// use serde::Serialize;
/// use ser_nix::{to_string, NixPathBuf};
///
/// #[derive(Serialize)]
/// struct Config {
///     source: NixPathBuf,
/// }
///
/// let config = Config {
///     source: NixPathBuf::new("./hardware-configuration.nix"),
/// };
///
/// let result = to_string(&config).unwrap();
/// assert!(result.contains("source = ./hardware-configuration.nix;"));
/// ```
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NixPathBuf(PathBuf);

impl NixPathBuf {
    /// Creates a new `NixPathBuf`.
    pub fn new(path: impl Into<PathBuf>) -> Self {
        NixPathBuf(path.into())
    }

    /// Returns a reference to the underlying `Path`.
    pub fn as_path(&self) -> &Path {
        &self.0
    }

    /// Converts into the underlying `PathBuf`.
    pub fn into_path_buf(self) -> PathBuf {
        self.0
    }
}

impl From<PathBuf> for NixPathBuf {
    fn from(path: PathBuf) -> Self {
        NixPathBuf(path)
    }
}

impl From<&Path> for NixPathBuf {
    fn from(path: &Path) -> Self {
        NixPathBuf(path.to_path_buf())
    }
}

impl From<&str> for NixPathBuf {
    fn from(s: &str) -> Self {
        NixPathBuf(PathBuf::from(s))
    }
}

impl AsRef<Path> for NixPathBuf {
    fn as_ref(&self) -> &Path {
        &self.0
    }
}

impl Deref for NixPathBuf {
    type Target = Path;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl Serialize for NixPathBuf {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serialize_path(&self.0, serializer)
    }
}

/// A borrowed path that serializes as a Nix path literal.
///
/// Use this wrapper type for borrowed paths. For owned paths, use [`NixPathBuf`].
///
/// # Example
///
/// ```
/// use serde::Serialize;
/// use ser_nix::{to_string, NixPath};
/// use std::path::Path;
///
/// let path = Path::new("./hardware-configuration.nix");
/// let nix_path = NixPath::new(path);
///
/// let result = to_string(&nix_path).unwrap();
/// assert_eq!(result, "./hardware-configuration.nix");
/// ```
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NixPath<'a>(&'a Path);

impl<'a> NixPath<'a> {
    /// Creates a new `NixPath` from a borrowed `Path`.
    pub fn new(path: &'a Path) -> Self {
        NixPath(path)
    }

    /// Returns a reference to the underlying `Path`.
    pub fn as_path(&self) -> &Path {
        self.0
    }
}

impl<'a> From<&'a Path> for NixPath<'a> {
    fn from(path: &'a Path) -> Self {
        NixPath(path)
    }
}

impl AsRef<Path> for NixPath<'_> {
    fn as_ref(&self) -> &Path {
        self.0
    }
}

impl Serialize for NixPath<'_> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serialize_path(self.0, serializer)
    }
}

/// Check if a path string contains characters that require quoting in Nix.
fn needs_quoting(s: &str) -> bool {
    let bytes = s.as_bytes();
    (0..bytes.len()).any(|i| {
        matches!(bytes[i], b'"' | b'\\' | b' ' | b'\t' | b'\n' | b'\r')
            || (bytes[i] == b'$' && bytes.get(i + 1) == Some(&b'{'))
    })
}

/// Escape a string for use inside a Nix double-quoted string, writing to an existing buffer.
fn escape_nix_string_into(s: &str, out: &mut String) {
    let mut chars = s.chars().peekable();
    while let Some(c) = chars.next() {
        match c {
            '"' => out.push_str("\\\""),
            '\\' => out.push_str("\\\\"),
            '$' if chars.peek() == Some(&'{') => out.push_str("\\$"),
            '\n' => out.push_str("\\n"),
            '\t' => out.push_str("\\t"),
            c => out.push(c),
        }
    }
}

fn serialize_path<S>(path: &Path, serializer: S) -> Result<S::Ok, S::Error>
where
    S: Serializer,
{
    let path_str = path
        .to_str()
        .ok_or_else(|| serde::ser::Error::custom("path contains invalid UTF-8 characters"))?;

    let has_special_chars = needs_quoting(path_str);

    let result: Cow<str> = if path.is_absolute() {
        if has_special_chars {
            // /. + "/path with spaces"
            let mut buf = String::with_capacity(6 + path_str.len());
            buf.push_str("/. + \"");
            escape_nix_string_into(path_str, &mut buf);
            buf.push('"');
            Cow::Owned(buf)
        } else {
            Cow::Borrowed(path_str)
        }
    } else {
        match path.components().next() {
            Some(Component::CurDir) => {
                if has_special_chars {
                    // ./. + "rest" (strip the ./ prefix, quote the rest)
                    let rest = path.strip_prefix(Component::CurDir).unwrap();
                    let rest_str = rest.to_str().unwrap();
                    let mut buf = String::with_capacity(7 + rest_str.len());
                    buf.push_str("./. + \"");
                    escape_nix_string_into(rest_str, &mut buf);
                    buf.push('"');
                    Cow::Owned(buf)
                } else {
                    Cow::Borrowed(path_str)
                }
            }
            Some(Component::ParentDir) => {
                if has_special_chars {
                    // ../. + "rest" (strip the ../ prefix, quote the rest)
                    let rest = path.strip_prefix(Component::ParentDir).unwrap();
                    let rest_str = rest.to_str().unwrap();
                    let mut buf = String::with_capacity(8 + rest_str.len());
                    buf.push_str("../. + \"");
                    escape_nix_string_into(rest_str, &mut buf);
                    buf.push('"');
                    Cow::Owned(buf)
                } else {
                    Cow::Borrowed(path_str)
                }
            }
            _ => {
                // Bare relative path - needs ./ prefix to avoid Nix search path interpretation
                if has_special_chars {
                    // ./. + "path"
                    let mut buf = String::with_capacity(7 + path_str.len());
                    buf.push_str("./. + \"");
                    escape_nix_string_into(path_str, &mut buf);
                    buf.push('"');
                    Cow::Owned(buf)
                } else {
                    // ./path
                    let mut buf = String::with_capacity(2 + path_str.len());
                    buf.push_str("./");
                    buf.push_str(path_str);
                    Cow::Owned(buf)
                }
            }
        }
    };

    serializer.serialize_newtype_struct(TOKEN, result.as_ref())
}

/// Serialize a `Path` or `PathBuf` as a Nix path literal.
///
/// Use this function with `#[serde(serialize_with = "...")]` to serialize
/// `Path` or `PathBuf` fields as path literals.
///
/// # Example
///
/// ```
/// use serde::Serialize;
/// use ser_nix::to_string;
/// use std::path::PathBuf;
///
/// #[derive(Serialize)]
/// struct Config {
///     #[serde(serialize_with = "ser_nix::as_nix_path")]
///     source: PathBuf,
/// }
///
/// let config = Config {
///     source: PathBuf::from("./hardware-configuration.nix"),
/// };
///
/// let result = to_string(&config).unwrap();
/// assert!(result.contains("source = ./hardware-configuration.nix;"));
/// ```
pub fn as_nix_path<S>(value: &Path, serializer: S) -> Result<S::Ok, S::Error>
where
    S: Serializer,
{
    serialize_path(value, serializer)
}

/// Serialize an `Option<PathBuf>` or `Option<&Path>` as a Nix path literal, or null if None.
///
/// # Example
///
/// ```
/// use serde::Serialize;
/// use ser_nix::to_string;
/// use std::path::PathBuf;
///
/// #[derive(Serialize)]
/// struct Config {
///     #[serde(serialize_with = "ser_nix::as_optional_nix_path")]
///     source: Option<PathBuf>,
/// }
///
/// let config = Config {
///     source: Some(PathBuf::from("./path.nix")),
/// };
///
/// let result = to_string(&config).unwrap();
/// assert!(result.contains("source = ./path.nix;"));
/// ```
pub fn as_optional_nix_path<P, S>(value: &Option<P>, serializer: S) -> Result<S::Ok, S::Error>
where
    P: AsRef<Path>,
    S: Serializer,
{
    match value {
        Some(v) => serialize_path(v.as_ref(), serializer),
        None => serializer.serialize_none(),
    }
}