[−][src]Crate butane
Modules
db | |
migrations | For working with migrations. If using the butane CLI tool, it is not necessary to use these types directly. |
prelude | Prelude module to improve ergonomics. |
query | Types to support database queries. Most users will use
the |
Macros
filter | Macro to construct a |
find | Finds a specific database object. |
query | Constructs a filtered database query. |
Structs
ForeignKey | Used to implement a relationship between models. |
Many | Used to implement a many-to-many relationship between models. |
ObjectState | Used internally by butane to track state about the object. |
Enums
Error | Butane errors. |
SqlType | Enumeration of the types a database value may take. |
SqlVal | A database value. |
Traits
AsPrimaryKey | Trait for referencing the primary key for a given model. Used to implement ForeignKey equality tests. |
DataObject | An object in the database. |
DataResult | A type which may be the result of a database query. |
FieldType | Type suitable for being a database column. |
FromSql | Used to convert a |
IntoSql | Used to convert another type to a |
ToSql | Used to convert another type to a |
Type Definitions
Result |
Attribute Macros
butane_type | Attribute macro which marks a type as being available to butane for use in models. |
dataresult | |
model | Attribute macro which marks a struct as being a data model and generates an implementation of [DataObject][crate::DataObject]. This macro will also write information to disk at compile time necessary to generate migrations |