microformats 0.17.0

A union library of the Microformats types and associated parser.
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

pub mod jf2;
pub mod parse;
pub use microformats_types as types;

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error(transparent)]
    Parse(#[from] parse::Error),

    #[error(transparent)]
    Types(#[from] types::Error),

    #[error(transparent)]
    IO(#[from] std::io::Error),

    #[error("Failed to generate HTML: {0}")]
    HtmlCodegen(String),

    #[error(transparent)]
    FromUtf8(#[from] std::string::FromUtf8Error),

    #[error("The required property {name:} was not of the type {kind:?}")]
    InvalidRequiredProperty { name: String, kind: String },

    #[error(transparent)]
    Json(#[from] serde_json::Error),

    #[error(transparent)]
    Jf2Profile(#[from] jf2::profiles::Error),
}

impl PartialEq for Error {
    fn eq(&self, other: &Self) -> bool {
        self.to_string().eq(&other.to_string())
    }
}

impl From<url::ParseError> for Error {
    fn from(value: url::ParseError) -> Self {
        Self::Parse(parse::Error::from(value))
    }
}

impl From<microformats_types::temporal::Error> for Error {
    fn from(value: microformats_types::temporal::Error) -> Self {
        Self::Types(types::Error::from(value))
    }
}

/// Parses the provided HTML into a `types::Document` resolved with the proviedd URL.
///
/// ```
/// use microformats::from_html;
///
/// let base_url: url::Url = "https://example.com".parse().unwrap();
/// let document = from_html(r#"
/// <html>
///     <head>
///         <link rel="author me" href="/author">
///     </head>
///     <body>
///     </body>
/// </html>
/// "#, &base_url);
///
/// assert!(document.is_ok());
/// ```
pub fn from_html(html: &str, url: &url::Url) -> Result<types::Document, Error> {
    parse::Parser::from_html(html.to_string())
        .and_then(|mut parser| parser.into_document(Some(url.clone())))
}

/// Parses the HTML stored in the provided reader into a `types::Document` resolved with the provided URL.
pub fn from_reader<R>(mut reader: R, url: &url::Url) -> Result<types::Document, Error>
where
    R: std::io::BufRead,
{
    let mut html = String::with_capacity(16384);
    reader
        .read_to_string(&mut html)
        .map_err(Error::IO)
        .and_then(|_| from_html(&html, url))
}

pub mod http;