//! Low level Postgres protocol APIs. //! //! This crate implements the low level components of Postgres's communication //! protocol, including message and value serialization and deserialization. //! It is designed to be used as a building block by higher level APIs such as //! `rust-postgres`, and should not typically be used directly. //! //! # Note //! //! This library assumes that the `client_encoding` backend parameter has been //! set to `UTF8`. It will most likely not behave properly if that is not the case. #![doc(html_root_url = "https://docs.rs/postgres-protocol/0.5")] #![warn(missing_docs, rust_2018_idioms, clippy::all)] use byteorder::{BigEndian, ByteOrder}; use bytes::{BufMut, BytesMut}; use std::io; pub mod authentication; pub mod message; pub mod types; /// A Postgres OID. pub type Oid = u32; /// An enum indicating if a value is `NULL` or not. pub enum IsNull { /// The value is `NULL`. Yes, /// The value is not `NULL`. No, } // https://github.com/tokio-rs/bytes/issues/170 struct B<'a>(&'a mut BytesMut); impl<'a> BufMut for B<'a> { #[inline] fn remaining_mut(&self) -> usize { usize::max_value() - self.0.len() } #[inline] unsafe fn advance_mut(&mut self, cnt: usize) { self.0.advance_mut(cnt); } #[inline] unsafe fn bytes_mut(&mut self) -> &mut [u8] { if !self.0.has_remaining_mut() { self.0.reserve(64); } self.0.bytes_mut() } } fn write_nullable(serializer: F, buf: &mut BytesMut) -> Result<(), E> where F: FnOnce(&mut BytesMut) -> Result, E: From, { let base = buf.len(); B(buf).put_i32_be(0); let size = match serializer(buf)? { IsNull::No => i32::from_usize(buf.len() - base - 4)?, IsNull::Yes => -1, }; BigEndian::write_i32(&mut buf[base..], size); Ok(()) } trait FromUsize: Sized { fn from_usize(x: usize) -> Result; } macro_rules! from_usize { ($t:ty) => { impl FromUsize for $t { #[inline] fn from_usize(x: usize) -> io::Result<$t> { if x > <$t>::max_value() as usize { Err(io::Error::new( io::ErrorKind::InvalidInput, "value too large to transmit", )) } else { Ok(x as $t) } } } }; } from_usize!(i16); from_usize!(i32);