Struct ORM 

pub struct ORM { /* private fields */ }

ORM is a struct that represents an Object-Relational Mapping (ORM) for a MySQL database. It contains a Mutex that guards an Option wrapping a Conn object from the mysql_async crate. The Conn object represents a connection to the MySQL database.

Implementations

impl ORM

pub async fn connect(url: String) -> Result<Arc<ORM>, ORMError>

where Arc<ORM>: Send + Sync + 'static,

connect is an asynchronous function that establishes a connection to a MySQL database. It takes a String parameter url which is the URL of the MySQL database. It returns a Result that contains an Arc<ORM> if the connection is successful. The Arc<ORM> is a thread-safe reference-counted pointer to the ORM object. If the connection is not successful, the Result contains an ORMError.

Trait Implementations

impl Debug for ORM

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ORMTrait<ORM> for ORM

This is the implementation of the ORMTrait for the ORM struct. The ORMTrait provides a set of methods for interacting with a database. These methods include adding data, finding data, modifying data, and removing data. It also provides methods for executing arbitrary queries and escaping strings. The ORM struct represents an Object-Relational Mapping (ORM) for a MySQL database.

fn add<T>(&self, data: T) -> QueryBuilder<'_, T, T, ORM>

where T: for<'a> Deserialize<'a> + TableDeserialize + TableSerialize + Serialize + Debug + 'static,

add is a method that constructs a SQL insert query for a given data object. It takes a generic parameter T that represents the data object. The data object must implement the Deserialize, TableDeserialize, TableSerialize, Serialize, and Debug traits. The Deserialize trait is used to deserialize the data object from a serialized format. The TableDeserialize and TableSerialize traits are used to convert the data object to and from a table format. The Serialize trait is used to serialize the data object into a serialized format. The Debug trait is used to format the data object for output during debugging. The method returns a QueryBuilder object that represents the SQL insert query. The QueryBuilder object is generic over the lifetime 'a, the result type R, the entity type E, and the ORM type O. The ORM type O must implement the ORMTrait.

fn last_insert_rowid<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<i64, ORMError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

last_insert_rowid is an asynchronous method that retrieves the row ID of the last inserted record. It returns a Result that contains the row ID as an i64 if the operation is successful. If the operation is not successful, the Result contains an ORMError. Currently, this method is hardcoded to always return 0 as the row ID. It first locks the conn field of the ORM struct, which is a Mutex guarding an Option wrapping a Conn object. If the conn field is None, it returns an ORMError::NoConnection. Otherwise, it returns Ok(0).

fn close<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), ORMError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

close is an asynchronous method that closes the database connection. It first locks the conn field of the ORM struct, which is a Mutex guarding an Option wrapping a Conn object. If the conn field is None, it returns an ORMError::NoConnection. Otherwise, it attempts to disconnect the Conn object. If the disconnection is successful, it returns Ok(()). If the disconnection is not successful, it returns an ORMError::MySQLError containing the error from the mysql_async library.

fn find_one<T>(&self, id: u64) -> QueryBuilder<'_, Option<T>, T, ORM>

where T: TableDeserialize + TableSerialize + for<'a> Deserialize<'a> + 'static,

find_one is a method that constructs a SQL select query to find a record by its ID. It takes a generic parameter T that represents the data object and an id of type u64. The data object must implement the Deserialize, TableDeserialize, TableSerialize traits and have a static lifetime. The Deserialize trait is used to deserialize the data object from a serialized format. The TableDeserialize and TableSerialize traits are used to convert the data object to and from a table format. The method returns a QueryBuilder object that represents the SQL select query. The QueryBuilder object is generic over the lifetime 'a, the result type R, the entity type E, and the ORM type O. The ORM type O must implement the ORMTrait.

fn find_many<T>(&self, query_where: &str) -> QueryBuilder<'_, Vec<T>, T, ORM>

where T: for<'a> Deserialize<'a> + TableDeserialize + Debug + 'static,

find_many is a method that constructs a SQL select query to find multiple records that match the provided WHERE clause. It takes a generic parameter T that represents the data object and a query_where of type &str which is the WHERE clause of the SQL query. The data object must implement the Deserialize, TableDeserialize traits and have a static lifetime. The Deserialize trait is used to deserialize the data object from a serialized format. The TableDeserialize trait is used to convert the data object from a table format. The method returns a QueryBuilder object that represents the SQL select query. The QueryBuilder object is generic over the lifetime 'a, the result type R, the entity type E, and the ORM type O. The ORM type O must implement the ORMTrait.

fn find_all<T>(&self) -> QueryBuilder<'_, Vec<T>, T, ORM>

where T: for<'a> Deserialize<'a> + TableDeserialize + Debug + 'static,

find_all is a method that constructs a SQL select query to find all records in a table. It takes a generic parameter T that represents the data object. The data object must implement the Deserialize, TableDeserialize traits and have a static lifetime. The Deserialize trait is used to deserialize the data object from a serialized format. The TableDeserialize trait is used to convert the data object from a table format. The method returns a QueryBuilder object that represents the SQL select query. The QueryBuilder object is generic over the lifetime 'a, the result type R, the entity type E, and the ORM type O. The ORM type O must implement the ORMTrait.

fn modify<T>(&self, data: T) -> QueryBuilder<'_, usize, (), ORM>

where T: TableDeserialize + TableSerialize + Serialize + 'static,

modify is a method that constructs a SQL update query for a given data object. It takes a generic parameter T that represents the data object. The data object must implement the TableDeserialize, TableSerialize, Serialize traits and have a static lifetime. The TableDeserialize and TableSerialize traits are used to convert the data object to and from a table format. The Serialize trait is used to serialize the data object into a serialized format. The method returns a QueryBuilder object that represents the SQL update query. The QueryBuilder object is generic over the lifetime 'a, the result type R, the entity type E, and the ORM type O. The ORM type O must implement the ORMTrait.

fn remove<T>(&self, data: T) -> QueryBuilder<'_, usize, (), ORM>

where T: TableDeserialize + TableSerialize + Serialize + 'static,

remove is a method that constructs a SQL delete query for a given data object. It takes a generic parameter T that represents the data object. The data object must implement the TableDeserialize, TableSerialize, Serialize traits and have a static lifetime. The TableDeserialize and TableSerialize traits are used to convert the data object to and from a table format. The Serialize trait is used to serialize the data object into a serialized format. The method returns a QueryBuilder object that represents the SQL delete query. The QueryBuilder object is generic over the lifetime 'a, the result type R, the entity type E, and the ORM type O. The ORM type O must implement the ORMTrait.

fn query<T>(&self, query: &str) -> QueryBuilder<'_, Vec<T>, T, ORM>

query is a method that constructs a QueryBuilder for a given SQL query. It takes a query of type &str which is the SQL query. The method returns a QueryBuilder object that represents the SQL query. The QueryBuilder object is generic over the lifetime 'a, the result type R, the entity type E, and the ORM type O. The ORM type O must implement the ORMTrait.

fn query_update(&self, query: &str) -> QueryBuilder<'_, usize, (), ORM>

query_update is a method that constructs a QueryBuilder for a given SQL update query. It takes a query of type &str which is the SQL update query. The method returns a QueryBuilder object that represents the SQL update query. The QueryBuilder object is generic over the lifetime 'a, the result type R, the entity type E, and the ORM type O. The ORM type O must implement the ORMTrait.

fn init<'life0, 'life1, 'async_trait>( &'life0 self, script: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), ORMError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

init is an asynchronous method that initializes the database with a provided script. It takes a script of type &str which is the path to the script file. The script file should contain SQL queries that initialize the database. The method reads the script file and executes the SQL queries in the script. It returns a Result that contains () if the operation is successful. If the operation is not successful, the Result contains an ORMError.

fn protect(&self, value: &str) -> String

Escapes a string to protect against SQL injection.

fn escape(str: &str) -> String

Escapes a string for use in a SQL query.

fn escape_json(input: &str) -> String

Escapes a string for use in a JSON value.

fn change<'life0, 'life1, 'async_trait>( &'life0 self, _update_query: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), ORMError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes an update query and returns a result.