kwik 1.19.2

A set of useful tools I use for my Ph.D. research.
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

/*
 * Copyright (c) Kia Shakiba
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

mod reader;
mod writer;

use std::{fmt::Display, io};

use csv::StringRecord;
use num_traits::AsPrimitive;

/// CSV row data.
#[derive(Default)]
pub struct RowData {
	data: StringRecord,
}

impl RowData {
	/// Returns `true` if the row is empty (i.e., has no columns).
	#[inline]
	pub fn is_empty(&self) -> bool {
		self.data.is_empty()
	}

	/// Returns the number of columns in the row.
	#[inline]
	pub fn len(&self) -> usize {
		self.data.len()
	}

	/// Returns the size of the row in bytes, including commas
	/// and the new line character.
	#[inline]
	pub fn size(&self) -> usize {
		let items_size = self
			.data
			.iter()
			.map(|item| item.len())
			.sum::<usize>();

		items_size + self.data.len()
	}

	/// Returns the column data at the supplied index.
	///
	/// # Errors
	///
	/// This function returns an error if the column does not exist.
	#[inline]
	pub fn get(&self, index: impl AsPrimitive<usize>) -> io::Result<&str> {
		self.data.get(index.as_()).ok_or(io::Error::new(
			io::ErrorKind::InvalidData,
			format!("Invalid CSV column {}", index.as_()),
		))
	}

	/// Adds a new column to the end of the row.
	#[inline]
	pub fn push<T>(&mut self, value: T)
	where
		T: Display,
	{
		self.data.push_field(&value.to_string());
	}
}

pub use crate::file::csv::{
	reader::{CsvReader, IntoIter, Iter, ReadRow},
	writer::{CsvWriter, WriteRow},
};