tvl-depot/tvix/nix-compat/src/wire/primitive.rs
Florian Klink fd749070e2 refactor(tvix/nix-compat/wire): move magic bytes to worker_protocol
`primitive.rs` implements reading and writing primitive (fixed-length)
types in the wire format, used in the the nix daemon protocol and NAR
format.

Move worker-protocol specific magic bytes to worker_protocol.rs (and
possibly further split there once needed)

Change-Id: If681c01e9460294619f1d000229b81f0ac745810
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11377
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Reviewed-by: picnoir picnoir <picnoir@alternativebit.fr>
2024-04-08 07:02:10 +00:00

74 lines
2.4 KiB
Rust

// SPDX-FileCopyrightText: 2023 embr <git@liclac.eu>
//
// SPDX-License-Identifier: EUPL-1.2
use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt};
#[allow(dead_code)]
/// Read a u64 from the AsyncRead (little endian).
pub async fn read_u64<R: AsyncReadExt + Unpin>(r: &mut R) -> std::io::Result<u64> {
r.read_u64_le().await
}
/// Write a u64 to the AsyncWrite (little endian).
pub async fn write_u64<W: AsyncWrite + Unpin>(w: &mut W, v: u64) -> std::io::Result<()> {
w.write_u64_le(v).await
}
#[allow(dead_code)]
/// Read a boolean from the AsyncRead, encoded as u64 (>0 is true).
pub async fn read_bool<R: AsyncRead + Unpin>(r: &mut R) -> std::io::Result<bool> {
Ok(read_u64(r).await? > 0)
}
#[allow(dead_code)]
/// Write a boolean to the AsyncWrite, encoded as u64 (>0 is true).
pub async fn write_bool<W: AsyncWrite + Unpin>(w: &mut W, v: bool) -> std::io::Result<()> {
write_u64(w, if v { 1u64 } else { 0u64 }).await
}
#[cfg(test)]
mod tests {
use super::*;
use tokio_test::io::Builder;
// Integers.
#[tokio::test]
async fn test_read_u64() {
let mut mock = Builder::new().read(&1234567890u64.to_le_bytes()).build();
assert_eq!(1234567890u64, read_u64(&mut mock).await.unwrap());
}
#[tokio::test]
async fn test_write_u64() {
let mut mock = Builder::new().write(&1234567890u64.to_le_bytes()).build();
write_u64(&mut mock, 1234567890).await.unwrap();
}
// Booleans.
#[tokio::test]
async fn test_read_bool_0() {
let mut mock = Builder::new().read(&0u64.to_le_bytes()).build();
assert!(!read_bool(&mut mock).await.unwrap());
}
#[tokio::test]
async fn test_read_bool_1() {
let mut mock = Builder::new().read(&1u64.to_le_bytes()).build();
assert!(read_bool(&mut mock).await.unwrap());
}
#[tokio::test]
async fn test_read_bool_2() {
let mut mock = Builder::new().read(&2u64.to_le_bytes()).build();
assert!(read_bool(&mut mock).await.unwrap());
}
#[tokio::test]
async fn test_write_bool_false() {
let mut mock = Builder::new().write(&0u64.to_le_bytes()).build();
write_bool(&mut mock, false).await.unwrap();
}
#[tokio::test]
async fn test_write_bool_true() {
let mut mock = Builder::new().write(&1u64.to_le_bytes()).build();
write_bool(&mut mock, true).await.unwrap();
}
}