Enum gen_epub_book::ops::BookElement

pub enum BookElement {
    Name(String),
    Content(PathBuf),
    StringContent(String),
    ImageContent(PathBuf),
    NetworkImageContent(Url),
    Cover(PathBuf),
    NetworkCover(Url),
    Include(PathBuf),
    NetworkInclude(Url),
    Description(PathBuf),
    StringDescription(String),
    NetworkDescription(Url),
    Author(String),
    Date(DateTime<FixedOffset>),
    Language(String),
}

A single element of the e-book

Parse a single line with BookElement::parse() or the whole descriptor with ops::parse_descriptor().

Use Display to desugar back to description form.

Examples

let input = "Image-Content: images/ch01.png";
assert_eq!(&BookElement::parse(input, ":", false).unwrap().unwrap().to_string(), input);

Variants

Name(String)

E-book's title

Required: yes
Type: plaintext
Amount: 1

Content(PathBuf)

Content to put in the e-book

The content is additionally parsed in search for the text chunk containing <!-- ePub title: "TOC_NAME" -->, where TOC_NAME is any string not containing the " character.

That string will be used as the TOC name of the content, which will allow users on e-book readers to jump directly to the content represented by the document containing this entry.

Required: no
Value: relative path to (X)HTML chunk
Amount: any

StringContent(String)

(X)HTML string to use as content

Required: no
Value: (X)HTML string
Amount: any

ImageContent(PathBuf)

Relative path to image to include in e-book

Required: no
Type: file path
Amount: any

NetworkImageContent(Url)

URL of image to include in e-book

Required: no
Type: file URL
Amount: any

Cover(PathBuf)

Relative path to image to use as e-book cover

Required: no
Type: file path
Amount: 0-1
Remarks: exclusive with Network-Cover

NetworkCover(Url)

URL of image to use as e-book cover

Required: no
Type: file URL
Amount: 0-1
Remarks: exclusive with Cover

Include(PathBuf)

Auxilliary file to include in e-book

This is useful for, e.g., CSS.

Required: no
Value: relative path to (X)HTML chunk
Amount: any

NetworkInclude(Url)

URL of auxilliary file to include in e-book

This is useful for, e.g., fonts.

Required: no
Type: file URL
Amount: any

Description(PathBuf)

Relative path to file containing the book's description

Required: no
Value: relative path to (X)HTML chunk
Amount: 0-1
Remarks: exclusive with String-Description and Network-Description

StringDescription(String)

Book's description

Required: no
Type: (X-)HTML
Amount: 0-1
Remarks: exclusive with Description and Network-Description

NetworkDescription(Url)

URL of auxilliary file containing the book's description

Required: no
Type: file URL
Amount: 0-1
Remarks: exclusive with Description and String-Description

Author(String)

E-book's author

Required: yes
Type: plaintext string
Amount: 1

Date(DateTime<FixedOffset>)

E-book's authoring/publishing date

Required: yes
Type: RFC3339-compliant date
Amount: 1

Language(String)

Language used in e-book

Required: yes
Type: BCP47-compliant language code
Amount: 1

Methods

impl BookElement

pub fn parse(
    line: &str,
    separator: &str,
    free_date: bool
) -> Result<Option<BookElement>, Error>

(Hopefully) get a book element from a descriptor line with a specified separator with the specified rigidness.

If the line isn't a descripting line or the line uses an unknown key, Ok(None) is returned.

Err will only be returned when parsing a DateTime or a Url fails.

If free_date is true, in addition to the default RFC3339, RFC2822 and Unix-timestamp+tt:zz are accepted as correct DateTime formats.

Any whitespace from both parts of the description line are stripped.

Examples

Incorrect format:

assert!(BookElement::parse("Date: Mon, 26 Dec 2016 02:01:20 +0100", ":", false).is_err());
assert!(BookElement::parse("Date: 1486564218", ":", true).is_err());
assert!(BookElement::parse("Network-Image-Content: http/i.imgur.com/ViQ2WED.jpg",
                           ":", false).is_err());

Not a description/unrecognised key:

assert_eq!(BookElement::parse("# comment", ":", false), Ok(None));
assert_eq!(BookElement::parse("NetworkImage_Content: that was a typo", ":", false), Ok(None));
assert_eq!(BookElement::parse("Content: used colon instead of equal sign ->", "=", false),
           Ok(None));
assert_eq!(BookElement::parse("Workers all over the world, unite!", ":", false), Ok(None));

Correct:

assert_eq!(BookElement::parse("Name: nabijaczleweli", ":", false),
           Ok(Some(BookElement::Name("nabijaczleweli".to_string()))));
assert_eq!(BookElement::parse("Date = 2017-02-08T15:30:18+01:00", "=", false),
           Ok(Some(BookElement::Date(
             DateTime::parse_from_rfc3339("2017-02-08T15:30:18+01:00").unwrap()))));
assert_eq!(BookElement::parse("Date = Wed, 08 Feb 2017 15:30:18 +0100", "=", true),
           Ok(Some(BookElement::Date(
             DateTime::parse_from_rfc2822("Wed, 08 Feb 2017 15:30:18 +0100").unwrap()))));
assert_eq!(BookElement::parse("Language INCREDIBLE COMMUNISM pl", "INCREDIBLE COMMUNISM", false),
           Ok(Some(BookElement::Language("pl".to_string()))));

pub fn name(&self) -> &'static str

Get the descriptor name of this element.

Examples

assert_eq!(BookElement::Name("nabijaczleweli".to_string()).name(), "Name");
assert_eq!(BookElement::Content(PathBuf::from("content/ch01.html")).name(), "Content");
assert_eq!(BookElement::NetworkImageContent(
               Url::parse("http://i.imgur.com/ViQ2WED.jpg").unwrap()).name(),
           "Network-Image-Content");

Trait Implementations

impl PartialEq<BookElement> for BookElement

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

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

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

This method tests for !=.

impl Ord for BookElement

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Clone for BookElement

fn clone(&self) -> BookElement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for BookElement

impl PartialOrd<BookElement> for BookElement

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

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

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

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

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

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

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

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

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

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

impl Debug for BookElement

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

Formats the value using the given formatter.

impl Display for BookElement

Format the element in a way that would make it parse()able again with the default separator without Free Date Format.

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

Formats the value using the given formatter.

impl Hash for BookElement

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].