Struct FileMetadata

pub struct FileMetadata {

    pub name: Option<String>,
    pub size: u64,
    pub entropy: f32,
    pub sha1: String,
    pub sha256: String,
    pub sha384: String,
    pub sha512: String,
    pub md5: String,
    pub lzjd: Option<String>,
    pub ssdeep: Option<String>,
    pub tlsh: Option<String>,
    pub humanhash: String,
    pub file_command: String,
}

Metadata about a file for storing as a record in Malware DB

Fields

name: Option<String>

File name

size: u64

File size in bytes

entropy: f32

Entropy of the file

sha1: String

SHA-1 hash

sha256: String

SHA-256 hash

sha384: String

SHA-384 hash

sha512: String

SHA-512 hash

md5: String

MD5 hash

lzjd: Option<String>

LZJD similarity hash

ssdeep: Option<String>

SSDeep similarity hash, if the file is large enough

tlsh: Option<String>

Trend Micro’s similarity hash (distance metric)

humanhash: String

Human Hash, based on https://github.com/zacharyvoase/humanhash

file_command: String

File command (or libmagic) description of the file

Implementations

impl FileMetadata

pub fn new(contents: &[u8], name: Option<&str>) -> Self

Get the collection of file measurements given a byte sequence

Panics

This won’t actually panic despite a call to .unwrap() because the input to that function is known to always be the correct size.

Trait Implementations

impl Clone for FileMetadata

fn clone(&self) -> FileMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileMetadata

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

Formats the value using the given formatter.