8df919dcf0
This groups most `wire` feature gated logic into a single module. The nix_daemon module will be gated by a feature that adds nix-compat-derive as a dependency. All of this is a way to break the crate2nix dependency cycle between nix-compat and nix-compat-derive(which depends on nix-compat for its doctests). Change-Id: I95938a6f280c11967371ff21f8b5a19e6d3d3805 Reviewed-on: https://cl.tvl.fyi/c/depot/+/12761 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de>
124 lines
3.5 KiB
Rust
124 lines
3.5 KiB
Rust
use std::error::Error as StdError;
|
|
use std::future::Future;
|
|
use std::{fmt, io};
|
|
|
|
use super::ProtocolVersion;
|
|
|
|
mod bytes;
|
|
mod collections;
|
|
#[cfg(feature = "nix-compat-derive")]
|
|
mod display;
|
|
mod int;
|
|
#[cfg(any(test, feature = "test"))]
|
|
pub mod mock;
|
|
mod writer;
|
|
|
|
pub use writer::{NixWriter, NixWriterBuilder};
|
|
|
|
pub trait Error: Sized + StdError {
|
|
fn custom<T: fmt::Display>(msg: T) -> Self;
|
|
|
|
fn io_error(err: std::io::Error) -> Self {
|
|
Self::custom(format_args!("There was an I/O error {}", err))
|
|
}
|
|
|
|
fn unsupported_data<T: fmt::Display>(msg: T) -> Self {
|
|
Self::custom(msg)
|
|
}
|
|
|
|
fn invalid_enum<T: fmt::Display>(msg: T) -> Self {
|
|
Self::custom(msg)
|
|
}
|
|
}
|
|
|
|
impl Error for io::Error {
|
|
fn custom<T: fmt::Display>(msg: T) -> Self {
|
|
io::Error::new(io::ErrorKind::Other, msg.to_string())
|
|
}
|
|
|
|
fn io_error(err: std::io::Error) -> Self {
|
|
err
|
|
}
|
|
|
|
fn unsupported_data<T: fmt::Display>(msg: T) -> Self {
|
|
io::Error::new(io::ErrorKind::InvalidData, msg.to_string())
|
|
}
|
|
}
|
|
|
|
pub trait NixWrite: Send {
|
|
type Error: Error;
|
|
|
|
/// Some types are serialized differently depending on the version
|
|
/// of the protocol and so this can be used for implementing that.
|
|
fn version(&self) -> ProtocolVersion;
|
|
|
|
/// Write a single u64 to the protocol.
|
|
fn write_number(&mut self, value: u64) -> impl Future<Output = Result<(), Self::Error>> + Send;
|
|
|
|
/// Write a slice of bytes to the protocol.
|
|
fn write_slice(&mut self, buf: &[u8]) -> impl Future<Output = Result<(), Self::Error>> + Send;
|
|
|
|
/// Write a value that implements `std::fmt::Display` to the protocol.
|
|
/// The protocol uses many small string formats and instead of allocating
|
|
/// a `String` each time we want to write one an implementation of `NixWrite`
|
|
/// can instead use `Display` to dump these formats to a reusable buffer.
|
|
fn write_display<D>(&mut self, msg: D) -> impl Future<Output = Result<(), Self::Error>> + Send
|
|
where
|
|
D: fmt::Display + Send,
|
|
Self: Sized,
|
|
{
|
|
async move {
|
|
let s = msg.to_string();
|
|
self.write_slice(s.as_bytes()).await
|
|
}
|
|
}
|
|
|
|
/// Write a value to the protocol.
|
|
/// Uses `NixSerialize::serialize` to write the value.
|
|
fn write_value<V>(&mut self, value: &V) -> impl Future<Output = Result<(), Self::Error>> + Send
|
|
where
|
|
V: NixSerialize + Send + ?Sized,
|
|
Self: Sized,
|
|
{
|
|
value.serialize(self)
|
|
}
|
|
}
|
|
|
|
impl<T: NixWrite> NixWrite for &mut T {
|
|
type Error = T::Error;
|
|
|
|
fn version(&self) -> ProtocolVersion {
|
|
(**self).version()
|
|
}
|
|
|
|
fn write_number(&mut self, value: u64) -> impl Future<Output = Result<(), Self::Error>> + Send {
|
|
(**self).write_number(value)
|
|
}
|
|
|
|
fn write_slice(&mut self, buf: &[u8]) -> impl Future<Output = Result<(), Self::Error>> + Send {
|
|
(**self).write_slice(buf)
|
|
}
|
|
|
|
fn write_display<D>(&mut self, msg: D) -> impl Future<Output = Result<(), Self::Error>> + Send
|
|
where
|
|
D: fmt::Display + Send,
|
|
Self: Sized,
|
|
{
|
|
(**self).write_display(msg)
|
|
}
|
|
|
|
fn write_value<V>(&mut self, value: &V) -> impl Future<Output = Result<(), Self::Error>> + Send
|
|
where
|
|
V: NixSerialize + Send + ?Sized,
|
|
Self: Sized,
|
|
{
|
|
(**self).write_value(value)
|
|
}
|
|
}
|
|
|
|
pub trait NixSerialize {
|
|
/// Write a value to the writer.
|
|
fn serialize<W>(&self, writer: &mut W) -> impl Future<Output = Result<(), W::Error>> + Send
|
|
where
|
|
W: NixWrite;
|
|
}
|