sql-composer 0.0.3

SQL template engine that composes reusable SQL fragments with parameterized bindings
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

//! Error types for sql-composer.

use std::path::PathBuf;

/// The error type for sql-composer operations.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// A referenced template file was not found on any search path.
    #[error("template not found: {path}")]
    TemplateNotFound {
        /// The path that was searched for.
        path: PathBuf,
    },

    /// A parse error occurred while processing a template.
    #[error("parse error at {location}: {message}")]
    Parse {
        /// Human-readable location description (e.g. line:col or offset).
        location: String,
        /// Description of the parse failure.
        message: String,
    },

    /// A binding referenced in the template was not provided values.
    #[error("binding '{name}' has no values")]
    MissingBinding {
        /// The name of the missing binding.
        name: String,
    },

    /// A compose reference could not be resolved.
    #[error("compose reference not found: {path}")]
    ComposeNotFound {
        /// The path of the unresolved compose reference.
        path: PathBuf,
    },

    /// A command references sources that could not be resolved.
    #[error("command source not found: {path}")]
    CommandSourceNotFound {
        /// The path of the unresolved source.
        path: PathBuf,
    },

    /// An I/O error occurred while reading a template file.
    #[error("io error: {0}")]
    Io(#[from] std::io::Error),

    /// A mock table was referenced but not registered.
    #[error("mock table '{name}' not registered")]
    MockNotFound {
        /// The name of the missing mock table.
        name: String,
    },

    /// A circular compose reference was detected.
    #[error("circular compose reference detected: {path}")]
    CircularReference {
        /// The path where the cycle was detected.
        path: PathBuf,
    },

    /// A slot referenced in a template was not provided by the caller.
    #[error("missing slot '@{name}' — not provided by caller")]
    MissingSlot {
        /// The name of the missing slot.
        name: String,
    },
}

/// A specialized `Result` type for sql-composer operations.
pub type Result<T> = std::result::Result<T, Error>;