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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
//! Conversions to and from Postgres types. //! //! This crate is used by the `tokio-postgres` and `postgres` crates. You normally don't need to depend directly on it //! unless you want to define your own `ToSql` or `FromSql` definitions. //! //! # Derive //! //! If the `derive` cargo feature is enabled, you can derive `ToSql` and `FromSql` implementations for custom Postgres //! types. //! //! ## Enums //! //! Postgres enums correspond to C-like enums in Rust: //! //! ```sql //! CREATE TYPE "Mood" AS ENUM ( //! 'Sad', //! 'Ok', //! 'Happy' //! ); //! ``` //! //! ```rust //! # #[cfg(feature = "derive")] //! use postgres_types::{ToSql, FromSql}; //! //! # #[cfg(feature = "derive")] //! #[derive(Debug, ToSql, FromSql)] //! enum Mood { //! Sad, //! Ok, //! Happy, //! } //! ``` //! //! ## Domains //! //! Postgres domains correspond to tuple structs with one member in Rust: //! //! ```sql //! CREATE DOMAIN "SessionId" AS BYTEA CHECK(octet_length(VALUE) = 16); //! ``` //! //! ```rust //! # #[cfg(feature = "derive")] //! use postgres_types::{ToSql, FromSql}; //! //! # #[cfg(feature = "derive")] //! #[derive(Debug, ToSql, FromSql)] //! struct SessionId(Vec<u8>); //! ``` //! //! ## Composites //! //! Postgres composite types correspond to structs in Rust: //! //! ```sql //! CREATE TYPE "InventoryItem" AS ( //! name TEXT, //! supplier_id INT, //! price DOUBLE PRECISION //! ); //! ``` //! //! ```rust //! # #[cfg(feature = "derive")] //! use postgres_types::{ToSql, FromSql}; //! //! # #[cfg(feature = "derive")] //! #[derive(Debug, ToSql, FromSql)] //! struct InventoryItem { //! name: String, //! supplier_id: i32, //! price: Option<f64>, //! } //! ``` //! //! ## Naming //! //! The derived implementations will enforce exact matches of type, field, and variant names between the Rust and //! Postgres types. The `#[postgres(name = "...")]` attribute can be used to adjust the name on a type, variant, or //! field: //! //! ```sql //! CREATE TYPE mood AS ENUM ( //! 'sad', //! 'ok', //! 'happy' //! ); //! ``` //! //! ```rust //! # #[cfg(feature = "derive")] //! use postgres_types::{ToSql, FromSql}; //! //! # #[cfg(feature = "derive")] //! #[derive(Debug, ToSql, FromSql)] //! #[postgres(name = "mood")] //! enum Mood { //! #[postgres(name = "sad")] //! Sad, //! #[postgres(name = "ok")] //! Ok, //! #[postgres(name = "happy")] //! Happy, //! } //! ``` #![doc(html_root_url = "https://docs.rs/postgres-types/0.1")] #![warn(clippy::all, rust_2018_idioms, missing_docs)] use fallible_iterator::FallibleIterator; use postgres_protocol::types::{self, ArrayDimension}; use std::any::type_name; use std::borrow::Cow; use std::collections::HashMap; use std::error::Error; use std::fmt; use std::hash::BuildHasher; use std::net::IpAddr; use std::sync::Arc; use std::time::{Duration, SystemTime, UNIX_EPOCH}; #[cfg(feature = "derive")] pub use postgres_derive::{FromSql, ToSql}; #[cfg(feature = "with-serde_json-1")] pub use crate::serde_json_1::Json; use crate::type_gen::{Inner, Other}; #[doc(inline)] pub use postgres_protocol::Oid; pub use crate::special::{Date, Timestamp}; use bytes::BytesMut; // Number of seconds from 1970-01-01 to 2000-01-01 const TIME_SEC_CONVERSION: u64 = 946_684_800; const USEC_PER_SEC: u64 = 1_000_000; const NSEC_PER_USEC: u64 = 1_000; /// Generates a simple implementation of `ToSql::accepts` which accepts the /// types passed to it. #[macro_export] macro_rules! accepts { ($($expected:ident),+) => ( fn accepts(ty: &$crate::Type) -> bool { matches!(*ty, $($crate::Type::$expected)|+) } ) } /// Generates an implementation of `ToSql::to_sql_checked`. /// /// All `ToSql` implementations should use this macro. #[macro_export] macro_rules! to_sql_checked { () => { fn to_sql_checked( &self, ty: &$crate::Type, out: &mut $crate::private::BytesMut, ) -> ::std::result::Result< $crate::IsNull, Box<dyn ::std::error::Error + ::std::marker::Sync + ::std::marker::Send>, > { $crate::__to_sql_checked(self, ty, out) } }; } // WARNING: this function is not considered part of this crate's public API. // It is subject to change at any time. #[doc(hidden)] pub fn __to_sql_checked<T>( v: &T, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>> where T: ToSql, { if !T::accepts(ty) { return Err(Box::new(WrongType::new::<T>(ty.clone()))); } v.to_sql(ty, out) } #[cfg(feature = "with-bit-vec-0_6")] mod bit_vec_06; #[cfg(feature = "with-chrono-0_4")] mod chrono_04; #[cfg(feature = "with-eui48-0_4")] mod eui48_04; #[cfg(feature = "with-geo-types-0_6")] mod geo_types_06; #[cfg(feature = "with-serde_json-1")] mod serde_json_1; #[cfg(feature = "with-time-0_2")] mod time_02; #[cfg(feature = "with-uuid-0_8")] mod uuid_08; // The time::{date, time} macros produce compile errors if the crate package is renamed. #[cfg(feature = "with-time-0_2")] extern crate time_02 as time; #[doc(hidden)] pub mod private; mod special; mod type_gen; /// A Postgres type. #[derive(PartialEq, Eq, Clone, Hash)] pub struct Type(Inner); impl fmt::Debug for Type { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt::Debug::fmt(&self.0, fmt) } } impl fmt::Display for Type { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { match self.schema() { "public" | "pg_catalog" => {} schema => write!(fmt, "{}.", schema)?, } fmt.write_str(self.name()) } } impl Type { /// Creates a new `Type`. pub fn new(name: String, oid: Oid, kind: Kind, schema: String) -> Type { Type(Inner::Other(Arc::new(Other { name, oid, kind, schema, }))) } /// Returns the `Type` corresponding to the provided `Oid` if it /// corresponds to a built-in type. pub fn from_oid(oid: Oid) -> Option<Type> { Inner::from_oid(oid).map(Type) } /// Returns the OID of the `Type`. pub fn oid(&self) -> Oid { self.0.oid() } /// Returns the kind of this type. pub fn kind(&self) -> &Kind { self.0.kind() } /// Returns the schema of this type. pub fn schema(&self) -> &str { match self.0 { Inner::Other(ref u) => &u.schema, _ => "pg_catalog", } } /// Returns the name of this type. pub fn name(&self) -> &str { self.0.name() } } /// Represents the kind of a Postgres type. #[derive(Debug, Clone, PartialEq, Eq, Hash)] #[non_exhaustive] pub enum Kind { /// A simple type like `VARCHAR` or `INTEGER`. Simple, /// An enumerated type along with its variants. Enum(Vec<String>), /// A pseudo-type. Pseudo, /// An array type along with the type of its elements. Array(Type), /// A range type along with the type of its elements. Range(Type), /// A domain type along with its underlying type. Domain(Type), /// A composite type along with information about its fields. Composite(Vec<Field>), } /// Information about a field of a composite type. #[derive(Debug, Clone, PartialEq, Eq, Hash)] pub struct Field { name: String, type_: Type, } impl Field { /// Creates a new `Field`. pub fn new(name: String, type_: Type) -> Field { Field { name, type_ } } /// Returns the name of the field. pub fn name(&self) -> &str { &self.name } /// Returns the type of the field. pub fn type_(&self) -> &Type { &self.type_ } } /// An error indicating that a `NULL` Postgres value was passed to a `FromSql` /// implementation that does not support `NULL` values. #[derive(Debug, Clone, Copy)] pub struct WasNull; impl fmt::Display for WasNull { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.write_str("a Postgres value was `NULL`") } } impl Error for WasNull {} /// An error indicating that a conversion was attempted between incompatible /// Rust and Postgres types. #[derive(Debug)] pub struct WrongType { postgres: Type, rust: &'static str, } impl fmt::Display for WrongType { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { write!( fmt, "cannot convert between the Rust type `{}` and the Postgres type `{}`", self.rust, self.postgres, ) } } impl Error for WrongType {} impl WrongType { /// Creates a new `WrongType` error. pub fn new<T>(ty: Type) -> WrongType { WrongType { postgres: ty, rust: type_name::<T>(), } } } /// A trait for types that can be created from a Postgres value. /// /// # Types /// /// The following implementations are provided by this crate, along with the /// corresponding Postgres types: /// /// | Rust type | Postgres type(s) | /// |-----------------------------------|-----------------------------------------------| /// | `bool` | BOOL | /// | `i8` | "char" | /// | `i16` | SMALLINT, SMALLSERIAL | /// | `i32` | INT, SERIAL | /// | `u32` | OID | /// | `i64` | BIGINT, BIGSERIAL | /// | `f32` | REAL | /// | `f64` | DOUBLE PRECISION | /// | `&str`/`String` | VARCHAR, CHAR(n), TEXT, CITEXT, NAME, UNKNOWN | /// | `&[u8]`/`Vec<u8>` | BYTEA | /// | `HashMap<String, Option<String>>` | HSTORE | /// | `SystemTime` | TIMESTAMP, TIMESTAMP WITH TIME ZONE | /// | `IpAddr` | INET | /// /// In addition, some implementations are provided for types in third party /// crates. These are disabled by default; to opt into one of these /// implementations, activate the Cargo feature corresponding to the crate's /// name prefixed by `with-`. For example, the `with-serde_json-1` feature enables /// the implementation for the `serde_json::Value` type. /// /// | Rust type | Postgres type(s) | /// |---------------------------------|-------------------------------------| /// | `chrono::NaiveDateTime` | TIMESTAMP | /// | `chrono::DateTime<Utc>` | TIMESTAMP WITH TIME ZONE | /// | `chrono::DateTime<Local>` | TIMESTAMP WITH TIME ZONE | /// | `chrono::DateTime<FixedOffset>` | TIMESTAMP WITH TIME ZONE | /// | `chrono::NaiveDate` | DATE | /// | `chrono::NaiveTime` | TIME | /// | `time::PrimitiveDateTime` | TIMESTAMP | /// | `time::OffsetDateTime` | TIMESTAMP WITH TIME ZONE | /// | `time::Date` | DATE | /// | `time::Time` | TIME | /// | `eui48::MacAddress` | MACADDR | /// | `geo_types::Point<f64>` | POINT | /// | `geo_types::Rect<f64>` | BOX | /// | `geo_types::LineString<f64>` | PATH | /// | `serde_json::Value` | JSON, JSONB | /// | `uuid::Uuid` | UUID | /// | `bit_vec::BitVec` | BIT, VARBIT | /// | `eui48::MacAddress` | MACADDR | /// /// # Nullability /// /// In addition to the types listed above, `FromSql` is implemented for /// `Option<T>` where `T` implements `FromSql`. An `Option<T>` represents a /// nullable Postgres value. /// /// # Arrays /// /// `FromSql` is implemented for `Vec<T>` where `T` implements `FromSql`, and /// corresponds to one-dimensional Postgres arrays. pub trait FromSql<'a>: Sized { /// Creates a new value of this type from a buffer of data of the specified /// Postgres `Type` in its binary format. /// /// The caller of this method is responsible for ensuring that this type /// is compatible with the Postgres `Type`. fn from_sql(ty: &Type, raw: &'a [u8]) -> Result<Self, Box<dyn Error + Sync + Send>>; /// Creates a new value of this type from a `NULL` SQL value. /// /// The caller of this method is responsible for ensuring that this type /// is compatible with the Postgres `Type`. /// /// The default implementation returns `Err(Box::new(WasNull))`. #[allow(unused_variables)] fn from_sql_null(ty: &Type) -> Result<Self, Box<dyn Error + Sync + Send>> { Err(Box::new(WasNull)) } /// A convenience function that delegates to `from_sql` and `from_sql_null` depending on the /// value of `raw`. fn from_sql_nullable( ty: &Type, raw: Option<&'a [u8]>, ) -> Result<Self, Box<dyn Error + Sync + Send>> { match raw { Some(raw) => Self::from_sql(ty, raw), None => Self::from_sql_null(ty), } } /// Determines if a value of this type can be created from the specified /// Postgres `Type`. fn accepts(ty: &Type) -> bool; } /// A trait for types which can be created from a Postgres value without borrowing any data. /// /// This is primarily useful for trait bounds on functions. pub trait FromSqlOwned: for<'a> FromSql<'a> {} impl<T> FromSqlOwned for T where T: for<'a> FromSql<'a> {} impl<'a, T: FromSql<'a>> FromSql<'a> for Option<T> { fn from_sql(ty: &Type, raw: &'a [u8]) -> Result<Option<T>, Box<dyn Error + Sync + Send>> { <T as FromSql>::from_sql(ty, raw).map(Some) } fn from_sql_null(_: &Type) -> Result<Option<T>, Box<dyn Error + Sync + Send>> { Ok(None) } fn accepts(ty: &Type) -> bool { <T as FromSql>::accepts(ty) } } impl<'a, T: FromSql<'a>> FromSql<'a> for Vec<T> { fn from_sql(ty: &Type, raw: &'a [u8]) -> Result<Vec<T>, Box<dyn Error + Sync + Send>> { let member_type = match *ty.kind() { Kind::Array(ref member) => member, _ => panic!("expected array type"), }; let array = types::array_from_sql(raw)?; if array.dimensions().count()? > 1 { return Err("array contains too many dimensions".into()); } array .values() .map(|v| T::from_sql_nullable(member_type, v)) .collect() } fn accepts(ty: &Type) -> bool { match *ty.kind() { Kind::Array(ref inner) => T::accepts(inner), _ => false, } } } impl<'a> FromSql<'a> for Vec<u8> { fn from_sql(_: &Type, raw: &'a [u8]) -> Result<Vec<u8>, Box<dyn Error + Sync + Send>> { Ok(types::bytea_from_sql(raw).to_owned()) } accepts!(BYTEA); } impl<'a> FromSql<'a> for &'a [u8] { fn from_sql(_: &Type, raw: &'a [u8]) -> Result<&'a [u8], Box<dyn Error + Sync + Send>> { Ok(types::bytea_from_sql(raw)) } accepts!(BYTEA); } impl<'a> FromSql<'a> for String { fn from_sql(_: &Type, raw: &'a [u8]) -> Result<String, Box<dyn Error + Sync + Send>> { types::text_from_sql(raw).map(ToString::to_string) } fn accepts(ty: &Type) -> bool { <&str as FromSql>::accepts(ty) } } impl<'a> FromSql<'a> for &'a str { fn from_sql(_: &Type, raw: &'a [u8]) -> Result<&'a str, Box<dyn Error + Sync + Send>> { types::text_from_sql(raw) } fn accepts(ty: &Type) -> bool { match *ty { Type::VARCHAR | Type::TEXT | Type::BPCHAR | Type::NAME | Type::UNKNOWN => true, ref ty if ty.name() == "citext" => true, _ => false, } } } macro_rules! simple_from { ($t:ty, $f:ident, $($expected:ident),+) => { impl<'a> FromSql<'a> for $t { fn from_sql(_: &Type, raw: &'a [u8]) -> Result<$t, Box<dyn Error + Sync + Send>> { types::$f(raw) } accepts!($($expected),+); } } } simple_from!(bool, bool_from_sql, BOOL); simple_from!(i8, char_from_sql, CHAR); simple_from!(i16, int2_from_sql, INT2); simple_from!(i32, int4_from_sql, INT4); simple_from!(u32, oid_from_sql, OID); simple_from!(i64, int8_from_sql, INT8); simple_from!(f32, float4_from_sql, FLOAT4); simple_from!(f64, float8_from_sql, FLOAT8); impl<'a, S> FromSql<'a> for HashMap<String, Option<String>, S> where S: Default + BuildHasher, { fn from_sql( _: &Type, raw: &'a [u8], ) -> Result<HashMap<String, Option<String>, S>, Box<dyn Error + Sync + Send>> { types::hstore_from_sql(raw)? .map(|(k, v)| Ok((k.to_owned(), v.map(str::to_owned)))) .collect() } fn accepts(ty: &Type) -> bool { ty.name() == "hstore" } } impl<'a> FromSql<'a> for SystemTime { fn from_sql(_: &Type, raw: &'a [u8]) -> Result<SystemTime, Box<dyn Error + Sync + Send>> { let time = types::timestamp_from_sql(raw)?; let epoch = UNIX_EPOCH + Duration::from_secs(TIME_SEC_CONVERSION); let negative = time < 0; let time = time.abs() as u64; let secs = time / USEC_PER_SEC; let nsec = (time % USEC_PER_SEC) * NSEC_PER_USEC; let offset = Duration::new(secs, nsec as u32); let time = if negative { epoch - offset } else { epoch + offset }; Ok(time) } accepts!(TIMESTAMP, TIMESTAMPTZ); } impl<'a> FromSql<'a> for IpAddr { fn from_sql(_: &Type, raw: &'a [u8]) -> Result<IpAddr, Box<dyn Error + Sync + Send>> { let inet = types::inet_from_sql(raw)?; Ok(inet.addr()) } accepts!(INET); } /// An enum representing the nullability of a Postgres value. pub enum IsNull { /// The value is NULL. Yes, /// The value is not NULL. No, } /// A trait for types that can be converted into Postgres values. /// /// # Types /// /// The following implementations are provided by this crate, along with the /// corresponding Postgres types: /// /// | Rust type | Postgres type(s) | /// |-----------------------------------|--------------------------------------| /// | `bool` | BOOL | /// | `i8` | "char" | /// | `i16` | SMALLINT, SMALLSERIAL | /// | `i32` | INT, SERIAL | /// | `u32` | OID | /// | `i64` | BIGINT, BIGSERIAL | /// | `f32` | REAL | /// | `f64` | DOUBLE PRECISION | /// | `&str`/`String` | VARCHAR, CHAR(n), TEXT, CITEXT, NAME | /// | `&[u8]`/`Vec<u8>` | BYTEA | /// | `HashMap<String, Option<String>>` | HSTORE | /// | `SystemTime` | TIMESTAMP, TIMESTAMP WITH TIME ZONE | /// | `IpAddr` | INET | /// /// In addition, some implementations are provided for types in third party /// crates. These are disabled by default; to opt into one of these /// implementations, activate the Cargo feature corresponding to the crate's /// name prefixed by `with-`. For example, the `with-serde_json-1` feature enables /// the implementation for the `serde_json::Value` type. /// /// | Rust type | Postgres type(s) | /// |---------------------------------|-------------------------------------| /// | `chrono::NaiveDateTime` | TIMESTAMP | /// | `chrono::DateTime<Utc>` | TIMESTAMP WITH TIME ZONE | /// | `chrono::DateTime<Local>` | TIMESTAMP WITH TIME ZONE | /// | `chrono::DateTime<FixedOffset>` | TIMESTAMP WITH TIME ZONE | /// | `chrono::NaiveDate` | DATE | /// | `chrono::NaiveTime` | TIME | /// | `time::PrimitiveDateTime` | TIMESTAMP | /// | `time::OffsetDateTime` | TIMESTAMP WITH TIME ZONE | /// | `time::Date` | DATE | /// | `time::Time` | TIME | /// | `eui48::MacAddress` | MACADDR | /// | `geo_types::Point<f64>` | POINT | /// | `geo_types::Rect<f64>` | BOX | /// | `geo_types::LineString<f64>` | PATH | /// | `serde_json::Value` | JSON, JSONB | /// | `uuid::Uuid` | UUID | /// | `bit_vec::BitVec` | BIT, VARBIT | /// | `eui48::MacAddress` | MACADDR | /// /// # Nullability /// /// In addition to the types listed above, `ToSql` is implemented for /// `Option<T>` where `T` implements `ToSql`. An `Option<T>` represents a /// nullable Postgres value. /// /// # Arrays /// /// `ToSql` is implemented for `Vec<T>` and `&[T]` where `T` implements `ToSql`, /// and corresponds to one-dimensional Postgres arrays with an index offset of 1. pub trait ToSql: fmt::Debug { /// Converts the value of `self` into the binary format of the specified /// Postgres `Type`, appending it to `out`. /// /// The caller of this method is responsible for ensuring that this type /// is compatible with the Postgres `Type`. /// /// The return value indicates if this value should be represented as /// `NULL`. If this is the case, implementations **must not** write /// anything to `out`. fn to_sql(&self, ty: &Type, out: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> where Self: Sized; /// Determines if a value of this type can be converted to the specified /// Postgres `Type`. fn accepts(ty: &Type) -> bool where Self: Sized; /// An adaptor method used internally by Rust-Postgres. /// /// *All* implementations of this method should be generated by the /// `to_sql_checked!()` macro. fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>; } impl<'a, T> ToSql for &'a T where T: ToSql, { fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>> { (*self).to_sql(ty, out) } fn accepts(ty: &Type) -> bool { T::accepts(ty) } to_sql_checked!(); } impl<T: ToSql> ToSql for Option<T> { fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>> { match *self { Some(ref val) => val.to_sql(ty, out), None => Ok(IsNull::Yes), } } fn accepts(ty: &Type) -> bool { <T as ToSql>::accepts(ty) } to_sql_checked!(); } impl<'a, T: ToSql> ToSql for &'a [T] { fn to_sql(&self, ty: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { let member_type = match *ty.kind() { Kind::Array(ref member) => member, _ => panic!("expected array type"), }; let dimension = ArrayDimension { len: downcast(self.len())?, lower_bound: 1, }; types::array_to_sql( Some(dimension), member_type.oid(), self.iter(), |e, w| match e.to_sql(member_type, w)? { IsNull::No => Ok(postgres_protocol::IsNull::No), IsNull::Yes => Ok(postgres_protocol::IsNull::Yes), }, w, )?; Ok(IsNull::No) } fn accepts(ty: &Type) -> bool { match *ty.kind() { Kind::Array(ref member) => T::accepts(member), _ => false, } } to_sql_checked!(); } impl<'a> ToSql for &'a [u8] { fn to_sql(&self, _: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { types::bytea_to_sql(*self, w); Ok(IsNull::No) } accepts!(BYTEA); to_sql_checked!(); } impl<T: ToSql> ToSql for Vec<T> { fn to_sql(&self, ty: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { <&[T] as ToSql>::to_sql(&&**self, ty, w) } fn accepts(ty: &Type) -> bool { <&[T] as ToSql>::accepts(ty) } to_sql_checked!(); } impl ToSql for Vec<u8> { fn to_sql(&self, ty: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { <&[u8] as ToSql>::to_sql(&&**self, ty, w) } fn accepts(ty: &Type) -> bool { <&[u8] as ToSql>::accepts(ty) } to_sql_checked!(); } impl<'a> ToSql for &'a str { fn to_sql(&self, _: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { types::text_to_sql(*self, w); Ok(IsNull::No) } fn accepts(ty: &Type) -> bool { match *ty { Type::VARCHAR | Type::TEXT | Type::BPCHAR | Type::NAME | Type::UNKNOWN => true, ref ty if ty.name() == "citext" => true, _ => false, } } to_sql_checked!(); } impl<'a> ToSql for Cow<'a, str> { fn to_sql(&self, ty: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { <&str as ToSql>::to_sql(&&self.as_ref(), ty, w) } fn accepts(ty: &Type) -> bool { <&str as ToSql>::accepts(ty) } to_sql_checked!(); } impl ToSql for String { fn to_sql(&self, ty: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { <&str as ToSql>::to_sql(&&**self, ty, w) } fn accepts(ty: &Type) -> bool { <&str as ToSql>::accepts(ty) } to_sql_checked!(); } macro_rules! simple_to { ($t:ty, $f:ident, $($expected:ident),+) => { impl ToSql for $t { fn to_sql(&self, _: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { types::$f(*self, w); Ok(IsNull::No) } accepts!($($expected),+); to_sql_checked!(); } } } simple_to!(bool, bool_to_sql, BOOL); simple_to!(i8, char_to_sql, CHAR); simple_to!(i16, int2_to_sql, INT2); simple_to!(i32, int4_to_sql, INT4); simple_to!(u32, oid_to_sql, OID); simple_to!(i64, int8_to_sql, INT8); simple_to!(f32, float4_to_sql, FLOAT4); simple_to!(f64, float8_to_sql, FLOAT8); impl<H> ToSql for HashMap<String, Option<String>, H> where H: BuildHasher, { fn to_sql(&self, _: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { types::hstore_to_sql( self.iter().map(|(k, v)| (&**k, v.as_ref().map(|v| &**v))), w, )?; Ok(IsNull::No) } fn accepts(ty: &Type) -> bool { ty.name() == "hstore" } to_sql_checked!(); } impl ToSql for SystemTime { fn to_sql(&self, _: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { let epoch = UNIX_EPOCH + Duration::from_secs(TIME_SEC_CONVERSION); let to_usec = |d: Duration| d.as_secs() * USEC_PER_SEC + u64::from(d.subsec_nanos()) / NSEC_PER_USEC; let time = match self.duration_since(epoch) { Ok(duration) => to_usec(duration) as i64, Err(e) => -(to_usec(e.duration()) as i64), }; types::timestamp_to_sql(time, w); Ok(IsNull::No) } accepts!(TIMESTAMP, TIMESTAMPTZ); to_sql_checked!(); } impl ToSql for IpAddr { fn to_sql(&self, _: &Type, w: &mut BytesMut) -> Result<IsNull, Box<dyn Error + Sync + Send>> { let netmask = match self { IpAddr::V4(_) => 32, IpAddr::V6(_) => 128, }; types::inet_to_sql(*self, netmask, w); Ok(IsNull::No) } accepts!(INET); to_sql_checked!(); } fn downcast(len: usize) -> Result<i32, Box<dyn Error + Sync + Send>> { if len > i32::max_value() as usize { Err("value too large to transmit".into()) } else { Ok(len as i32) } } mod sealed { pub trait Sealed {} } /// A trait used by clients to abstract over `&dyn ToSql` and `T: ToSql`. /// /// This cannot be implemented outside of this crate. pub trait BorrowToSql: sealed::Sealed { /// Returns a reference to `self` as a `ToSql` trait object. fn borrow_to_sql(&self) -> &dyn ToSql; } impl sealed::Sealed for &dyn ToSql {} impl BorrowToSql for &dyn ToSql { #[inline] fn borrow_to_sql(&self) -> &dyn ToSql { *self } } impl<T> sealed::Sealed for T where T: ToSql {} impl<T> BorrowToSql for T where T: ToSql, { #[inline] fn borrow_to_sql(&self) -> &dyn ToSql { self } }