esi 0.6.2

A streaming parser and executor for Edge Side Includes
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

use thiserror::Error;

use fastly::http::request::SendError;

/// Describes an error encountered during ESI parsing or execution.
#[derive(Error, Debug)]
#[allow(clippy::large_enum_variant)]
pub enum ExecutionError {
    /// Invalid XML was encountered during parsing.
    #[error("xml parsing error: {0}")]
    XMLError(#[from] quick_xml::Error),

    /// The ESI document contains a tag with a missing parameter.
    #[error("tag `{0}` is missing required parameter `{1}`")]
    MissingRequiredParameter(String, String),

    /// The ESI document contains an opening tag where it doesn't belong.
    #[error("unexpected `{0}` opening tag")]
    UnexpectedOpeningTag(String),

    /// The ESI document contains an opening tag without a matching closing tag.
    #[error("unexpected `{0}` closing tag")]
    UnexpectedClosingTag(String),

    // One or more of the URLs in the ESI template were invalid.
    #[error("invalid request URL provided: `{0}`")]
    InvalidRequestUrl(String),

    /// An error occurred when sending a fragment request to a backend.
    #[error("error sending request: {0}")]
    RequestError(#[from] SendError),

    /// An ESI fragment request returned an unexpected HTTP status code.
    #[error("received unexpected status code for fragment `{0}`: {1}")]
    UnexpectedStatus(String, u16),

    /// This error is returned when the parser encounters an unexpected end of document.
    #[error("unexpected end of document")]
    UnexpectedEndOfDocument,

    /// Writer error
    #[error("writer error: {0}")]
    WriterError(#[from] std::io::Error),

    /// Expression error
    #[error("expression failed to evaluate: `{0}`")]
    ExpressionError(String),

    /// An error occurred while creating a regular expression in an eval context
    #[error("failed to create a regular expression")]
    RegexError(#[from] regex::Error),

    /// An error occurred while executing a function in an eval context
    #[error("failed to execute a function: `{0}`")]
    FunctionError(String),
}

pub type Result<T> = std::result::Result<T, ExecutionError>;