csv_lib 1.0.7

Library for parsing CSV files using memory-mapped I/O, with low alloc, and AVX2/NEON support
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

use crate::decoders::decoders::Encoding;

#[derive(Debug,Clone)]
#[allow(dead_code)]
/// ## CsvConfig Struct
///
/// - Stores the config used to read a CSV File.
pub struct CsvConfig {
    /// Force function to use memchr3. is more compatible, but don't take advantage of NEON / AVX2 feature
    pub force_memcach3 : bool,
    /// A u8 with the byte of the chars that can be considered as delimiter.
    pub delimiter: u8,
    /// Allow to define a string delimiter. Use `0u8` if you want to disable it
    pub string_separator: u8,
    /// Defines the line break char
    pub line_break: u8,
    /// Defines de encoding used to open the file.
    pub encoding: Encoding,
}


impl Default for CsvConfig {
    /// ## Default for `CsvConfig`
    /// - Implements the default construction for struct CsvConfig
    /// ### Code Example:
    /// ```
    /// //Import zone
    /// use csv_lib::decoders::decoders::Encoding;
    /// use csv_lib::models::csv_config::CsvConfig;
    ///
    /// //Default CsvConfig construction
    /// let a = CsvConfig{
    ///  force_memcach3 : false,
    ///   delimiter : b';',
    ///   string_separator:0u8,
    ///   line_break: b'\n',
    ///   encoding : Encoding::Windows1252
    /// };
    /// ```
    fn default() -> Self {
        Self {
            force_memcach3 : false,
            delimiter : b';',
            string_separator:0u8,
            line_break: b'\n',
            encoding: Encoding::Windows1252,
        }
    }
}

impl CsvConfig {

    #[allow(dead_code)]
    #[inline(always)]
    /// ## New Function:
    /// - Creates a new instance of the struct `CsvConfig`
    pub fn new(
        delimiter: u8,
        string_separators: u8,
        line_break: u8,
        encoding: Encoding,
        force_memcach3: bool
    ) -> Self {
        Self {
            force_memcach3,
            delimiter,
            string_separator: string_separators,
            line_break,
            encoding,
        }
    }
}