gix-index 0.56.0

A work-in-progress crate of the gitoxide project dedicated implementing the git index file
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

use crate::extension::{Signature, end_of_index_entry::SIGNATURE};
use gix_error::ExnResult;

/// Write this extension to out and generate a hash of `object_hash` over all `prior_extensions` which are specified as `(signature, size)`
/// pair. `one_past_entries` is the offset to the first byte past the entries, which is also the first byte of the signature of the
/// first extension in `prior_extensions`. Note that `prior_extensions` must have been written prior to this one, as the name suggests,
/// allowing this extension to be the last one in the index file.
///
/// Even if there are no `prior_extensions`, this extension will be written unconditionally.
pub fn write_to(
    mut out: impl std::io::Write,
    object_hash: gix_hash::Kind,
    offset_to_extensions: u32,
    prior_extensions: impl IntoIterator<Item = (Signature, u32)>,
) -> ExnResult {
    out.write_all(&SIGNATURE).map_err(gix_hash::io::from_std_io)?;
    let extension_size: u32 = 4 + object_hash.len_in_bytes() as u32;
    out.write_all(&extension_size.to_be_bytes())
        .map_err(gix_hash::io::from_std_io)?;

    out.write_all(&offset_to_extensions.to_be_bytes())
        .map_err(gix_hash::io::from_std_io)?;

    let mut hasher = gix_hash::hasher(object_hash);
    for (signature, size) in prior_extensions {
        hasher.update(&signature);
        hasher.update(&size.to_be_bytes());
    }
    out.write_all(hasher.try_finalize().map_err(gix_hash::io::from_hasher)?.as_slice())
        .map_err(gix_hash::io::from_std_io)?;

    Ok(())
}