sqlayout 0.1.5

Generates SQL-code for creating SQLite databases via API or XML config
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

use thiserror::Error;
#[cfg(feature = "rusqlite")]
use rusqlite::{Error as RusqliteError};
#[cfg(feature = "rusqlite")]
use std::fmt::{Error as FmtError};

/// Errors for all Structs and Functions in this Crate.
#[derive(Error, Debug, PartialEq)]
#[allow(clippy::enum_variant_names)]
pub enum Error {
    /// Error used when a [ForeignKey](crate::ForeignKey) has a empty `foreign_table` Name
    #[error("Foreign Table Name cannot be Empty")]
    EmptyForeignTableName,

    /// Error used when a [ForeignKey](crate::ForeignKey) has a empty `foreign_column` Name
    #[error("Foreign Column Name cannot be Empty")]
    EmptyForeignColumnName,

    /// Error used when a [Column](crate::Column) has a empty `name`
    #[error("Column Name cannot be Empty")]
    EmptyColumnName,

    /// Error used when a [Column](crate::Column) has a [PrimaryKey](crate::PrimaryKey) and [ForeignKey](crate::ForeignKey) at the same time
    #[error("Column cannot be a Primary Key and a Foreign Key at the same Time")]
    PrimaryKeyAndForeignKey,

    /// Error used when a [Column](crate::Column) has a [PrimaryKey](crate::PrimaryKey) and [Unique](crate::Unique) at the same time
    /// (Primary Key implies Unique, see [here](https://www.sqlite.org/lang_createtable.html#unique_constraints))
    #[error("Primary Key implies Unique")]
    PrimaryKeyAndUnique,

    /// Error used when a [Table](crate::Table) has a empty `name`
    #[error("Table Name cannot be Empty")]
    EmptyTableName,

    /// Error used when a [Table](crate::Table) has no [Columns](crate::Column)
    #[error("Table must have Columns")]
    NoColumns,

    /// Error used when a [Table](crate::Table) has multiple [Columns](crate::Column) with a [PrimaryKey](crate::PrimaryKey)
    #[error("Table can only have one Primary Key")]
    MultiplePrimaryKeys,

    /// Error used when a table marked as `without_rowid` has no [Column](crate::Column) with a [PrimaryKey](crate::PrimaryKey)
    /// (`WITHOUT ROWID` tables need a Primary Key, see [here](https://www.sqlite.org/withoutrowid.html#differences_from_ordinary_rowid_tables))
    #[error("Tables without rowid must have one Primary Key")]
    WithoutRowidNoPrimaryKey,

    /// Error used when a [Schema](crate::Schema) has no [Tables](crate::Table)
    #[error("Schema must contain Tables")]
    SchemaWithoutTables,
}

#[cfg(feature = "rusqlite")]
#[derive(Error, Debug, PartialEq)]
pub enum CheckError {
    /// Error pass though when a [RusqliteError](rusqlite::Error) occurs
    #[error(transparent)]
    RusqliteError(#[from] RusqliteError),

    /// Error pass though a [FmtError](std::fmt::Error) occurs
    #[error(transparent)]
    FmtError(#[from] FmtError),
}

/// Result type used in this crate, Error type is [Error](enum@crate::error::Error)
pub type Result<T, E = Error> = std::result::Result<T, E>;