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 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
#![deny(missing_docs)]
//! Derive [`FromRow`] to generate a mapping between a struct and postgres rows.
//!
//! This crate works with [postgres](<https://docs.rs/postgres>) by default.
//!
//! ```toml
//! [dependencies]
//! postgres_from_row = "0.1.0"
//! ```
//!
//! If you want to use it with [tokio-postgres](<https://docs.rs/tokio-postgres>), enable it like so:
//!
//! ```toml
//! [dependencies]
//! postgres_from_row = { version = "0.1.0", default_features = false, features = ["tokio-postgres"] }
//! ```
//! # Examples
//! ```rust
//! use postgres_from_row::FromRow;
//!
//! #[derive(FromRow)]
//! struct Todo {
//! todo_id: i32,
//! text: String
//! author_id: i32,
//! }
//!
//! let row = client.query_one("SELECT todo_id, text, author_id FROM todos").unwrap();
//!
//! // Pass a row with the correct columns.
//! let todo = Todo::from_row(&row);
//!
//! let row = client.query_one("SELECT foo FROM bar").unwrap();
//!
//! // Use `try_from_row` if the operation could fail.
//! let todo = Todo::try_from_row(&row);
//! assert!(todo.is_err());
//! ```
//!
//! Each field need's to implement [`postgres::types::FromSql`], as this will be used to convert a
//! single column to the specified type. If you want to override this behavior and delegate it to a
//! nested structure that also implements [`FromRow`], use `#[from_row(flatten)]`:
//!
//! ```rust
//! use postgres_from_row::FromRow;
//!
//! #[derive(FromRow)]
//! struct Todo {
//! todo_id: i32,
//! text: String,
//! #[from_row(flatten)]
//! author: User
//! }
//!
//! #[derive(FromRow)]
//! struct User {
//! user_id: i32,
//! username: String
//! }
//!
//! let row = client.query_one("SELECT todo_id, text, user_id, username FROM todos t, users u WHERE t.author_id = u.user_id").unwrap();
//! let todo = Todo::from_row(&row);
//! ```
//!
#[cfg(feature = "postgres")]
mod active_postgres {
pub use postgres::{Error, Row};
pub use postgres_from_row_derive::FromRowPostgres as FromRow;
}
#[cfg(feature = "tokio-postgres")]
mod active_postgres {
pub use postgres_from_row_derive::FromRowTokioPostgres as FromRow;
pub use tokio_postgres::{Error, Row};
}
/// A trait that allows mapping rows from either [postgres](<https://docs.rs/postgres>) or [tokio-postgres](<https://docs.rs/tokio-postgres>), to other types.
#[cfg(any(feature = "postgres", feature = "tokio-postgres"))]
pub trait FromRow: Sized {
/// Performce the conversion
///
/// # Panics
///
/// panics if the row does not contain the expected column names.
fn from_row(row: &active_postgres::Row) -> Self;
/// Try's to perform the conversion.
///
/// Will return an error if the row does not contain the expected column names.
fn try_from_row(row: &active_postgres::Row) -> Result<Self, active_postgres::Error>;
}
#[doc(no_inline)]
/// gfdsfd
pub use active_postgres::FromRow;
//
// #[cfg(all(feature = "postgres", feature = "tokio-postgres"))]
// compile_error!("Can't combine feature `postgres` and `tokio-postgres`");
//
// #[cfg(not(any(feature = "postgres", feature = "tokio-postgres")))]
// compile_error!("Must have at least one enabled feature: `postgres` or `tokio-postgres`.");