compression-codecs 0.4.37

Adaptors for various compression algorithms.
Documentation
use crate::DecodeV2;
use compression_core::{
    unshared::Unshared,
    util::{PartialBuffer, WriteBuffer},
};
use lz4::liblz4::{
    check_error, LZ4FDecompressionContext, LZ4F_createDecompressionContext, LZ4F_decompress,
    LZ4F_freeDecompressionContext, LZ4F_resetDecompressionContext, LZ4F_VERSION,
};
use std::io::Result;

#[derive(Debug)]
struct DecoderContext {
    ctx: LZ4FDecompressionContext,
}

#[derive(Debug)]
pub struct Lz4Decoder {
    ctx: Unshared<DecoderContext>,
    stream_ended: bool,
}

impl DecoderContext {
    fn new() -> Result<Self> {
        let mut context = LZ4FDecompressionContext(core::ptr::null_mut());
        check_error(unsafe { LZ4F_createDecompressionContext(&mut context, LZ4F_VERSION) })?;
        Ok(Self { ctx: context })
    }
}

impl Drop for DecoderContext {
    fn drop(&mut self) {
        unsafe { LZ4F_freeDecompressionContext(self.ctx) };
    }
}

impl Default for Lz4Decoder {
    fn default() -> Self {
        Self {
            ctx: Unshared::new(DecoderContext::new().unwrap()),
            stream_ended: false,
        }
    }
}

impl Lz4Decoder {
    pub fn new() -> Self {
        Self::default()
    }
}

impl DecodeV2 for Lz4Decoder {
    fn reinit(&mut self) -> Result<()> {
        unsafe { LZ4F_resetDecompressionContext(self.ctx.get_mut().ctx) };
        self.stream_ended = false;
        Ok(())
    }

    fn decode(
        &mut self,
        input: &mut PartialBuffer<&[u8]>,
        output: &mut WriteBuffer<'_>,
    ) -> Result<bool> {
        let mut input_size = input.unwritten().len();

        // Safety: We **trust** lz4 bytes to properly function as expected,
        // only write decompressed, initialized data into the buffer properly.
        let result = unsafe {
            let out_buf = output.unwritten_mut();

            let mut output_size = out_buf.len();

            let result = check_error(LZ4F_decompress(
                self.ctx.get_mut().ctx,
                out_buf.as_mut_ptr() as *mut _,
                &mut output_size,
                input.unwritten().as_ptr(),
                &mut input_size,
                core::ptr::null(),
            ))?;
            output.assume_init_and_advance(output_size);

            result
        };
        input.advance(input_size);

        let finished = result == 0;
        if finished {
            self.stream_ended = true;
        }
        Ok(finished)
    }

    fn flush(&mut self, output: &mut WriteBuffer<'_>) -> Result<bool> {
        self.decode(&mut PartialBuffer::new(&[][..]), output)?;

        loop {
            let old_len = output.written_len();
            self.decode(&mut PartialBuffer::new(&[][..]), output)?;
            if output.written_len() == old_len {
                break;
            }
        }

        Ok(!output.has_no_spare_space())
    }

    fn finish(&mut self, output: &mut WriteBuffer<'_>) -> Result<bool> {
        self.flush(output)?;

        if self.stream_ended {
            Ok(true)
        } else {
            Err(std::io::Error::new(
                std::io::ErrorKind::UnexpectedEof,
                "lz4 stream did not finish",
            ))
        }
    }
}