[go: up one dir, main page]

rkyv 0.8.0-rc.2

Zero-copy deserialization framework for Rust
Documentation
use std::io;

use rancor::{ResultExt as _, Source};

use crate::ser::{Positional, Writer};

/// Wraps a type that implements [`io::Write`](std::io::Write) and equips it
/// with [`Writer`].
///
/// # Examples
/// ```
/// # use rkyv::ser::{Writer, Positional, writer::IoWriter};
/// use rkyv::rancor::{Error, Strategy};
/// let mut io_writer = IoWriter::new(Vec::new());
/// // In most cases, calling a method like `serialize` will wrap the writer in
/// // a Strategy for us.
/// let mut writer = Strategy::<_, Error>::wrap(&mut io_writer);
/// assert_eq!(writer.pos(), 0);
/// writer.write(&[0u8, 1u8, 2u8, 3u8]);
/// assert_eq!(writer.pos(), 4);
/// let buf = io_writer.into_inner();
/// assert_eq!(buf.len(), 4);
/// assert_eq!(buf, vec![0u8, 1u8, 2u8, 3u8]);
/// ```
#[derive(Debug)]
pub struct IoWriter<W> {
    inner: W,
    pos: usize,
}

impl<W> IoWriter<W> {
    /// Creates a new serializer from a writer.
    pub fn new(inner: W) -> Self {
        Self::with_pos(inner, 0)
    }

    /// Creates a new serializer from a writer, and assumes that the underlying
    /// writer is currently at the given position.
    pub fn with_pos(inner: W, pos: usize) -> Self {
        Self { inner, pos }
    }

    /// Consumes the serializer and returns the internal writer used to create
    /// it.
    pub fn into_inner(self) -> W {
        self.inner
    }
}

impl<W> Positional for IoWriter<W> {
    fn pos(&self) -> usize {
        self.pos
    }
}

impl<W: io::Write, E: Source> Writer<E> for IoWriter<W> {
    fn write(&mut self, bytes: &[u8]) -> Result<(), E> {
        self.inner.write_all(bytes).into_error()?;
        self.pos += bytes.len();
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use rancor::Failure;

    use crate::{
        api::serialize_using, ser::writer::IoWriter, util::Align, Archive,
        Serialize,
    };

    #[test]
    fn write_serializer() {
        #[derive(Archive, Serialize)]
        #[rkyv(crate, attr(repr(C)))]
        struct Example {
            x: i32,
        }

        let mut buf = Align([0u8; 3]);
        let mut ser = IoWriter::new(&mut buf[..]);
        let foo = Example { x: 100 };
        serialize_using::<_, Failure>(&foo, &mut ser)
            .expect_err("serialized to an undersized buffer must fail");
    }
}