Struct mobi::headers::MobiMetadata

pub struct MobiMetadata {
    pub name: Vec<u8>,
    pub header: Header,
    pub records: PdbRecords,
    pub palmdoc: PalmDocHeader,
    pub mobi: MobiHeader,
    pub exth: ExtHeader,
}

Holds all headers containing low level metadata of a mobi book

Fields

name: Vec<u8>

header: Header

records: PdbRecords

palmdoc: PalmDocHeader

mobi: MobiHeader

exth: ExtHeader

Implementations

impl MobiMetadata

pub fn new<B: AsRef<Vec<u8>>>(
    bytes: B
) -> Result<MobiMetadata, MetadataParseError>

Construct a Metadata object from a slice of bytes

pub fn from_path<P: AsRef<Path>>(
    file_path: P
) -> Result<MobiMetadata, MetadataParseError>

Construct a Metadata object from passed file path

pub fn from_read<R: Read>(reader: R) -> Result<MobiMetadata, MetadataParseError>

Construct a Metadata object from an object that implements a Read trait

pub fn exth_record(&self, record: ExthRecord) -> Option<&Vec<Vec<u8>>>

Returns raw ExthRecord data located at appropriate position if it exists. It is highly recommended to use public api provided here to access those records but in case where lower level access is needed this method provides access to all fields.

Some records can occur multiple times thats why a list of data buffers is returned.

pub fn exth_record_at(&self, position: u32) -> Option<&Vec<Vec<u8>>>

Returns raw ExthRecord data located at passed position if it exists.

If unsure where the wanted record is located at use exth_record method that limits possible position to those commonly available on mobi books.

It is highly recommended to instead use public api provided here to access those records but in case where lower level access is needed this method provides access to all fields.

Some records can occur multiple times thats why a list of data buffers is returned.

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

Returns an author of this book

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

Returns this books publisher

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

Returns description record if such exists

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

Returns isbn record if such exists

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

Returns publish_date record if such exists

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

Returns contributor record if such exists

pub fn title(&self) -> String

Returns title record read from EXTH header if it exists or defaults to full book name read from location specified in MOBI header.

pub fn text_encoding(&self) -> TextEncoding

Returns text encoding used in ebook

pub fn mobi_type(&self) -> MobiType

Returns type of this ebook

pub fn language(&self) -> Language

Returns language of the ebook

pub fn created_datetime(&self) -> NaiveDateTime

Returns creation datetime This field is only available using time feature

pub fn mod_datetime(&self) -> NaiveDateTime

Returns modification datetime This field is only available using time feature

pub fn compression(&self) -> Compression

Returns compression method used on this file

pub fn encryption(&self) -> Encryption

Returns encryption method used on this file

pub fn subjects(&self) -> Option<Vec<String>>

Returns a list of subject records as a string if such records exist

Trait Implementations

impl Debug for MobiMetadata

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

Formats the value using the given formatter.

impl Default for MobiMetadata

fn default() -> MobiMetadata

Returns the “default value” for a type.