convo 0.1.2

A modern dialogue executor and tree parser using YAML, focusing on ease-of-use and speed.
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

//! A family of related errors when working with [`convo`][`crate`].

/// An [`ExportError`] is a category of errors returned by exporter functions that returns [`Result`]s.
#[derive(Debug)]
pub enum ExportError {
    /// An error caused when IO issues occur during exporting.
    IO(std::io::Error),
    /// An error caused when YAML is unable to be emitted.
    Emit(yaml_rust::EmitError),
    /// An error caused when a tree is not considered legal to export.
    /// See also: [validation rules](https://github.com/simbleau/convo/blob/dev/FORMATTING.md#validation-rules).
    Validation(TreeError),
}
impl From<std::io::Error> for ExportError {
    fn from(item: std::io::Error) -> Self {
        ExportError::IO(item)
    }
}
impl From<yaml_rust::EmitError> for ExportError {
    fn from(item: yaml_rust::EmitError) -> Self {
        ExportError::Emit(item)
    }
}
impl From<TreeError> for ExportError {
    fn from(item: TreeError) -> Self {
        ExportError::Validation(item)
    }
}

/// A [`ImportError`] is a category of errors returned by parser functions that returns [`Result`]s.
#[derive(Debug)]
pub enum ImportError {
    /// An error caused when IO issues occur during importing.
    IO(std::io::Error),
    /// An error caused when YAML is unable to be scanned in.
    Scan(yaml_rust::ScanError),
    /// An error caused when a tree is not considered legal when parsing.
    /// See also: [validation rules](https://github.com/simbleau/convo/blob/dev/FORMATTING.md#validation-rules).
    Validation(TreeError),
    /// An error caused when the target content contains multiple YAML documents.
    MultipleDocumentsProvided(),
}
impl From<std::io::Error> for ImportError {
    fn from(item: std::io::Error) -> Self {
        ImportError::IO(item)
    }
}
impl From<yaml_rust::ScanError> for ImportError {
    fn from(item: yaml_rust::ScanError) -> Self {
        ImportError::Scan(item)
    }
}
impl From<TreeError> for ImportError {
    fn from(item: TreeError) -> Self {
        ImportError::Validation(item)
    }
}

/// A [`TreeError`] is a category of validation errors returned when a tree is not considered legal.
/// See also: [validation rules](https://github.com/simbleau/convo/blob/dev/FORMATTING.md#validation-rules).
#[derive(Debug)]
pub enum TreeError {
    /// An error caused when a [`crate::Tree`] is missing a root [`crate::Node`].
    /// See also: [`crate::Tree#root`][`crate::Tree#structfield.root].
    RootNotSet(),
    /// An error caused when a [`crate::Tree`] is missing a current [`crate::Node`].
    /// See also: [`crate::Tree#current`][`crate::Tree#structfield.current].
    CurrentNotSet(),
    /// An error caused when a [`crate::Tree`] is missing a necessary [`crate::Node`].
    NodeDNE(String),
    /// An error caused when validating a family of rules a [`crate::Tree`] must obey.
    Validation(String),
}