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
75
76
77
78
79
80
81
82
83

/*
 * 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::{cmp, mem};

pub use crate::file::binary::{
	reader::{BinaryReader, IntoIter, Iter, ReadChunk},
	writer::{BinaryWriter, WriteChunk},
};

/// Implementing this trait specifies the number of bytes each
/// chunk occupies in the binary file. The file will be read in chunks
/// of that size.
///
/// # Examples
/// ```
/// use kwik::file::binary::SizedChunk;
///
/// struct MyStruct {
///     // data fields
/// }
///
/// impl SizedChunk for MyStruct {
///     fn chunk_size() -> usize { 10 }
/// }
/// ```
pub trait SizedChunk {
	fn chunk_size() -> usize;
}

impl<T> SizedChunk for Option<T>
where
	T: SizedChunk,
{
	fn chunk_size() -> usize {
		T::chunk_size() + 1
	}
}

impl<T, E> SizedChunk for Result<T, E>
where
	T: SizedChunk,
	E: SizedChunk,
{
	fn chunk_size() -> usize {
		cmp::max(T::chunk_size(), E::chunk_size()) + 1
	}
}

macro_rules! impl_sized_chunk_primitive {
	($T:ty) => {
		impl SizedChunk for $T {
			#[inline]
			fn chunk_size() -> usize {
				mem::size_of::<$T>()
			}
		}
	};
}

impl_sized_chunk_primitive!(u8);
impl_sized_chunk_primitive!(i8);
impl_sized_chunk_primitive!(u16);
impl_sized_chunk_primitive!(i16);
impl_sized_chunk_primitive!(u32);
impl_sized_chunk_primitive!(i32);
impl_sized_chunk_primitive!(u64);
impl_sized_chunk_primitive!(i64);
impl_sized_chunk_primitive!(u128);
impl_sized_chunk_primitive!(i128);
impl_sized_chunk_primitive!(usize);
impl_sized_chunk_primitive!(isize);
impl_sized_chunk_primitive!(f32);
impl_sized_chunk_primitive!(f64);
impl_sized_chunk_primitive!(char);
impl_sized_chunk_primitive!(bool);