twig-doc 2.6.0

Parse, query, edit, and losslessly round-trip Djot, Markdown, HTML, and XML documents.
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

use std::fmt;

use crate::ffi;

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum Error {
    InvalidArgument,
    ParseError,
    OutOfMemory,
    UnsupportedFormat,
    /// A locator resolved to no node (editor).
    NotFound,
    /// A selector locator matched more than one node (editor).
    Ambiguous,
    /// The target node has no editable span/interior (editor).
    NotEditable,
    /// The edit produced a document that no longer parses; it was rolled back
    /// (editor).
    EditConflict,
    /// A metadata block's body contains `</script`, so it can't be emitted into
    /// a raw-text `<script>` HTML data island without an injection risk; the
    /// HTML printer refused (render/serialize-to-HTML).
    UnsafeMetadata,
    Internal,
}

impl Error {
    pub(crate) fn from_status(status: ffi::TwigStatus) -> Result<(), Self> {
        match status.0 {
            ffi::TwigStatus::OK => Ok(()),
            ffi::TwigStatus::INVALID_ARGUMENT => Err(Self::InvalidArgument),
            ffi::TwigStatus::PARSE_ERROR => Err(Self::ParseError),
            ffi::TwigStatus::OUT_OF_MEMORY => Err(Self::OutOfMemory),
            ffi::TwigStatus::UNSUPPORTED_FORMAT => Err(Self::UnsupportedFormat),
            ffi::TwigStatus::NOT_FOUND => Err(Self::NotFound),
            ffi::TwigStatus::AMBIGUOUS => Err(Self::Ambiguous),
            ffi::TwigStatus::NOT_EDITABLE => Err(Self::NotEditable),
            ffi::TwigStatus::EDIT_CONFLICT => Err(Self::EditConflict),
            ffi::TwigStatus::UNSAFE_METADATA => Err(Self::UnsafeMetadata),
            _ => Err(Self::Internal),
        }
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::InvalidArgument => f.write_str("invalid argument"),
            Error::ParseError => f.write_str("parse error"),
            Error::OutOfMemory => f.write_str("out of memory"),
            Error::UnsupportedFormat => f.write_str("unsupported format"),
            Error::NotFound => f.write_str("locator matched no node"),
            Error::Ambiguous => f.write_str("selector matched more than one node"),
            Error::NotEditable => f.write_str("node has no editable span"),
            Error::EditConflict => f.write_str("edit produced an unparseable document"),
            Error::UnsafeMetadata => f.write_str("metadata contains </script; unsafe to embed in HTML"),
            Error::Internal => f.write_str("internal error"),
        }
    }
}

impl std::error::Error for Error {}