subtile 0.4.1

A crate of utils to operate traitements on subtitles
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

//! Try to guess the types of files on disk.

use super::VobSubError;
use std::{fs, io::Read as _, path::Path};

/// Internal helper function which looks for "magic" bytes at the start of
/// a file.
fn has_magic(path: &Path, magic: &[u8]) -> Result<bool, VobSubError> {
    let mkerr = |source| VobSubError::Io {
        source,
        path: path.into(),
    };

    let mut f = fs::File::open(path).map_err(mkerr)?;
    let mut bytes = vec![0; magic.len()];
    f.read_exact(&mut bytes).map_err(mkerr)?;
    Ok(magic == &bytes[..])
}

/// Does the specified path appear to point to an `*.idx` file?
/// # Errors
///
/// Will return `Err` if the file can't be read.
pub fn is_idx_file<P: AsRef<Path>>(path: P) -> Result<bool, VobSubError> {
    has_magic(path.as_ref(), b"# VobSub index file")
}

/// Does the specified path appear to point to a `*.sub` file?
///
/// Note that this may (or may not) return false positives for certain
/// MPEG-2 related formats.
///
/// # Errors
///
/// Will return `Err` if the file can't be read.
pub fn is_sub_file<P: AsRef<Path>>(path: P) -> Result<bool, VobSubError> {
    has_magic(path.as_ref(), &[0x00, 0x00, 0x01, 0xba])
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn probe_idx_files() {
        assert!(is_idx_file("./fixtures/tiny.idx").unwrap());
        assert!(!is_idx_file("./fixtures/tiny.sub").unwrap());
    }

    #[test]
    fn probe_sub_files() {
        assert!(is_sub_file("./fixtures/tiny.sub").unwrap());
        assert!(!is_sub_file("./fixtures/tiny.idx").unwrap());
    }
}