Struct sfv::Sfv

pub struct Sfv {
    pub files: BTreeMap<PathBuf, Vec<u8>>,
}

Fields

files: BTreeMap<PathBuf, Vec<u8>>

The file paths and their checksums/hashes

Implementations

impl Sfv

pub fn new() -> Self

Create a new, empty Sfv object

pub fn from_sfv<P: AsRef<Path>, S: AsRef<str>>(
    base_directory: P,
    sfv: S
) -> Result<Self, ()>

Convert a SFV file in string format to a Sfv object.

use sfv::Sfv;
use std::collections::BTreeMap;
use std::path::PathBuf;

let sfv_file = r#"
 ; This is a comment
  file_one.zip   c45ad668
  file_two.zip   7903b8e6
  file_three.zip e99a65fb
"#;

let sfv = Sfv::from_sfv("/test", sfv_file).unwrap();
assert_eq!(
    *sfv.files.get(&PathBuf::from("/test/file_one.zip")).unwrap(),
    vec![0xc4, 0x5a, 0xd6, 0x68]
)

pub fn add_file<P: AsRef<Path>, D: AsRef<[u8]>>(&mut self, path: P, data: D)

Adds a file and checksum entry to the Sfv.

use sfv::Sfv;
use std::path::PathBuf;

let mut sfv = Sfv::new();
let path = PathBuf::from("/test.txt");
let checksum: Vec<u8> = vec![0x42, 0x42, 0x42, 0x42];
sfv.add_file(&path, &checksum);

assert_eq!(
    *sfv.files.get(&PathBuf::from("/test.txt")).unwrap(),
    vec![0x42, 0x42, 0x42, 0x42]
)

Trait Implementations

impl Clone for Sfv

fn clone(&self) -> Sfv

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Sfv

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Sfv

fn default() -> Sfv

Returns the "default value" for a type.

impl Display for Sfv

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Sfv

impl Ord for Sfv

fn cmp(&self, other: &Sfv) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Sfv> for Sfv

fn eq(&self, other: &Sfv) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Sfv) -> bool

This method tests for !=.

impl PartialOrd<Sfv> for Sfv

fn partial_cmp(&self, other: &Sfv) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Sfv) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Sfv) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Sfv) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Sfv) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Sfv

impl StructuralPartialEq for Sfv