Struct kitab::meta::MetaData

pub struct MetaData { /* private fields */ }

Represents the full metadata for a media file.

Implementations

impl MetaData

pub fn new(
    title: &str,
    author: &str,
    entry_type: EntryType,
    digest: RecordDigest,
    filename: Option<FileName>
) -> MetaData

Create a new MetaData instance with basic data.

Arguments

• title - Maps to the DCMetaData::title field.
• author - Maps to the DCMetaData::author field.
• entry_type - Maps to the DCMetaData::typ field.
• digest - The digest of the media file.
• filename - The client’s optional local file name for the media.

pub fn empty() -> MetaData

Create an empty MetaData instance.

pub fn set_title(&mut self, title: &str)

Set the DCMetaData::title value.

pub fn set_author(&mut self, author: &str)

Set the DCMetaData::author value.

pub fn set_fingerprint(&mut self, fingerprint: RecordDigest)

Set the digest as digest::RecordDigest::Sha512 instance of the provided fingerprint.

pub fn set_fingerprint_urn(&mut self, urn: &str)

Set the digest from the given URN string.

The URN must specify a valid supported digest scheme.

pub fn title(&self) -> String

Returns the current DCMetaData::title value.

pub fn author(&self) -> String

Returns the current DCMetaData::author value.

pub fn set_typ(&mut self, typ: &str)

Set the DCMetaData::typ value.

pub fn typ(&self) -> EntryType

Returns the current DCMetaData::typ value.

pub fn set_subject(&mut self, v: &str)

Set the current DCMetaData::subject value.

pub fn subject(&self) -> Option<String>

Returns the current DCMetaData::subject value.

pub fn set_mime(&mut self, m: Mime)

Set the current DCMetaData::mime value.

pub fn set_mime_str(&mut self, s: &str)

Set the current DCMetaData::mime value from the given MIME identifier string.

pub fn mime(&self) -> Option<Mime>

Returns the current DCMetaData::mime value.

pub fn set_language(&mut self, s: &str)

Set the current DCMetaData::language value.

pub fn language(&self) -> Option<LanguageIdentifier>

Returns the current DCMetaData::language value.

pub fn urn(&self) -> String

pub fn fingerprint(&self) -> String

pub fn from_xattr(filepath: &Path) -> Result<MetaData, ParseError>

Instantiate metadata from the extended attributes of the file in filepath.

pub fn to_xattr(&self, filepath: &Path) -> Result<(), Error>

Applies the metadata as extended file attributes of the file in filepath.

Will always export:

• title
• creator
• category of file contents

Will export, if defined:

• language
• MIME type of file
• A description of the subject matter of the file contents

pub fn set_mime_magic(&mut self, path: &Path)

Automatically detect media type of file in path.

pub fn from_path(p: &Path) -> Result<MetaData, Error>

Parse metadata from simplified metadata format contained in file in path.

see MetaData::from_file

pub fn from_file(f: File) -> Result<MetaData, Error>

Parse metadata from simplified metadata format contained in the given file instance f.

TODO: describe format.

pub fn validate(&self) -> bool

Check whether a Metadata instance represents a valid entry.

Trait Implementations

impl Debug for MetaData

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

Formats the value using the given formatter.