kxio 3.0.0

Provides injectable Filesystem and Network resources to make code more testable
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

//
use std::{fmt::Display, path::Path, str::Lines};

use crate::fs::Result;

use super::Error;

/// A reader for a file.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct Reader {
    contents: String,
}
impl Reader {
    pub(super) fn new(path: &Path) -> Result<Self> {
        let contents = std::fs::read_to_string(path).map_err(Error::Io)?;
        Ok(Self { contents })
    }

    /// Returns the contents of the file as a string.
    ///
    /// ```
    /// # use kxio::fs::Result;
    /// # fn main() -> Result<()> {
    /// let fs = kxio::fs::temp()?;
    /// let path = fs.base().join("foo");
    /// let file = fs.file(&path);
    /// # file.write("new file contents")?;
    /// let contents = file.reader()?.as_str();
    /// #    Ok(())
    /// # }
    /// ```
    pub fn as_str(&self) -> &str {
        &self.contents
    }

    /// Returns an iterator over the lines in the file.
    ///
    /// ```
    /// # use kxio::fs::Result;
    /// # fn main() -> Result<()> {
    /// let fs = kxio::fs::temp()?;
    /// let path = fs.base().join("foo");
    /// let file = fs.file(&path);
    /// # file.write("new file contents")?;
    /// let lines = file.reader()?.lines();
    /// #    Ok(())
    /// # }
    /// ```
    pub fn lines(&self) -> Lines<'_> {
        self.contents.lines()
    }

    /// Returns the contents of the file as bytes.
    ///
    /// ```
    /// # use kxio::fs::Result;
    /// # fn main() -> Result<()> {
    /// let fs = kxio::fs::temp()?;
    /// let path = fs.base().join("foo");
    /// let file = fs.file(&path);
    /// # file.write("new file contents")?;
    /// let bytes = file.reader()?.bytes();
    /// #    Ok(())
    /// # }
    /// ```
    pub fn bytes(&self) -> &[u8] {
        self.contents.as_bytes()
    }
}
impl Display for Reader {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.contents)
    }
}