gix_utils/
lib.rs

1//! A crate with utilities that don't need feature toggles.
2//!
3//! If they would need feature toggles, they should be in `gix-features` instead.
4#![deny(rust_2018_idioms, missing_docs)]
5#![forbid(unsafe_code)]
6
7///
8pub mod backoff;
9
10///
11pub mod buffers;
12
13///
14pub mod str;
15
16///
17pub mod btoi;
18
19/// A utility to do buffer-swapping with.
20///
21/// Use `src` to read from and `dest` to write to, and after actually changing data, call [Buffers::swap()].
22/// To be able to repeat the process, this time using what was `dest` as `src`, freeing up `dest` for writing once more.
23///
24/// Note that after each [`Buffers::swap()`], `src` is the most recent version of the data, just like before each swap.
25#[derive(Default, Clone)]
26pub struct Buffers {
27    /// The source data, as basis for processing.
28    pub src: Vec<u8>,
29    /// The data produced after processing `src`.
30    pub dest: Vec<u8>,
31}