lzfse_rust 0.1.0

A pure Rust LZFSE library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use crate::lmd::MatchDistance;
use crate::types::{ShortBuffer, ShortWriter};

use super::backend_type::BackendType;

use std::io;

pub trait Backend {
    type Type: BackendType;

    /// Initialize the backend.
    ///
    /// `len` is the input length with None indicating that either the exact value is unknown or
    /// is larger than `u32::MAX`.
    fn init<O: ShortWriter>(&mut self, dst: &mut O, len: Option<u32>) -> io::Result<()>;

    /// Push a literal block. Literals should be coalesced into the largest possible block size,
    /// failure to do so will reduce the compression ratio or may cause the backend to panic.
    fn push_literals<I: ShortBuffer, O: ShortWriter>(
        &mut self,
        dst: &mut O,
        literals: I,
    ) -> io::Result<()>;

    fn push_match<I: ShortBuffer, O: ShortWriter>(
        &mut self,
        dst: &mut O,
        literals: I,
        match_len: u32,
        match_distance: MatchDistance<Self::Type>,
    ) -> io::Result<()>;

    /// Implementations should NOT flush `dst`.
    fn finalize<O: ShortWriter>(&mut self, dst: &mut O) -> io::Result<()>;
}