iof 0.5.0

Read from and write data to console or file in simple formats.
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

use crate::{stdout, SepBy};
use dimension::Dimension;
use separator::Separator;
use separators::{DefaultSeparator, Separators};
use std::{
    collections::{BTreeSet, BinaryHeap, HashSet, LinkedList, VecDeque},
    io::{self, Write},
};

pub mod dimension;
mod impls;
mod macros;
pub(super) mod sep_by;
pub mod separator;
pub(super) mod separators;
pub(super) mod writer;

type Result<T = ()> = io::Result<T>;

/// Write into a stream.
///
/// - Most types that implement [std::fmt::Display] also implement this.
/// - [Vec] and `[T]` where `T` implements [std::fmt::Display] also implements this.
///   They write each item separated by a space.
/// - [Mat] where `T` implements [std::fmt::Display] also implements this.
///   They write each row separated by a newline, and each item in a row separated by a space.
///
/// [Mat]: crate::Mat
pub trait WriteInto: Dimension {
    /// Write into a stream with given separator.
    fn try_write_into_with_sep<S: Write + ?Sized>(&self, s: &mut S, sep: impl Separators)
        -> Result;
    /// Write into a stream using the default separator.
    #[inline]
    fn try_write_into<S: Write + ?Sized>(&self, s: &mut S) -> Result {
        self.try_write_into_with_sep(s, DefaultSeparator::new())
    }
    /// Write into a string with given separator.
    #[inline]
    fn try_write_into_string_with_sep(&self, sep: impl Separators) -> Result<String> {
        let mut s = Vec::new();
        self.try_write_into_with_sep(&mut s, sep)?;
        // What if the string is not valid UTF-8?
        String::from_utf8(s).map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))
    }
    /// Write into a string using the default separator.
    #[inline]
    fn try_write_into_string(&self) -> Result<String> {
        self.try_write_into_string_with_sep(DefaultSeparator::new())
    }
    /// Write into [std::io::Stdout] with given separator.
    #[inline]
    fn try_write_with_sep(&self, sep: impl Separators) -> Result {
        self.try_write_into_with_sep(&mut stdout(), sep)
    }
    /// Write into [std::io::Stdout] using the default separator.
    #[inline]
    fn try_write(&self) -> Result {
        self.try_write_with_sep(DefaultSeparator::new())
    }
}

impl<T: WriteInto> WriteInto for Vec<T> {
    #[inline]
    fn try_write_into_with_sep<S: Write + ?Sized>(
        &self,
        s: &mut S,
        sep: impl Separators,
    ) -> Result<()> {
        self.as_slice().try_write_into_with_sep(s, sep)
    }
}

impl<T: WriteInto, const N: usize> WriteInto for [T; N] {
    #[inline]
    fn try_write_into_with_sep<S: Write + ?Sized>(
        &self,
        s: &mut S,
        sep: impl Separators,
    ) -> Result<()> {
        self.as_slice().try_write_into_with_sep(s, sep)
    }
}

macro_rules! impl_write_into_for_into_iter {
    ($ty:ty) => {
        impl<T: WriteInto> WriteInto for $ty {
            #[inline]
            fn try_write_into_with_sep<S: Write + ?Sized>(
                &self,
                s: &mut S,
                sep: impl Separators,
            ) -> Result<()> {
                let (sep, residual) = sep.split();
                if let Some(sep) = &sep {
                    WriteInto::try_write_into_with_sep(&self.sep_by_write_into(sep), s, residual)
                } else {
                    WriteInto::try_write_into_with_sep(
                        &self.sep_by_write_into(Self::get_default_separator()),
                        s,
                        residual,
                    )
                }
            }
        }
    };
}

impl_write_into_for_into_iter!([T]);
impl_write_into_for_into_iter!(HashSet<T>);
impl_write_into_for_into_iter!(BTreeSet<T>);
impl_write_into_for_into_iter!(VecDeque<T>);
impl_write_into_for_into_iter!(BinaryHeap<T>);
impl_write_into_for_into_iter!(LinkedList<T>);

macro_rules! impl_write_into_for_deref {
    ($ty:ty) => {
        impl<T: WriteInto + ?Sized> WriteInto for $ty {
            #[inline]
            fn try_write_into_with_sep<S: Write + ?Sized>(
                &self,
                s: &mut S,
                sep: impl Separators,
            ) -> Result<()> {
                <T as WriteInto>::try_write_into_with_sep(self, s, sep)
            }
        }
    };
}

impl_write_into_for_deref!(&T);
impl_write_into_for_deref!(&mut T);
impl_write_into_for_deref!(Box<T>);
impl_write_into_for_deref!(std::rc::Rc<T>);
impl_write_into_for_deref!(std::sync::Arc<T>);