lzvn 0.1.1

Safe, clean-room LZVN encode/decode support for raw streams and Apple wrappers
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

/// Status returned by an incremental encoder or decoder step.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum StreamStatus {
  /// More input is required before progress can continue.
  NeedInput,
  /// More output space is required before progress can continue.
  NeedOutput,
  /// The stream has completed successfully.
  Finished,
}

/// Progress information returned by an incremental encoder or decoder step.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct StreamProgress {
  /// The number of bytes written into the caller-provided output buffer.
  pub written: usize,
  /// The next action required to continue processing.
  pub status: StreamStatus,
}

impl StreamProgress {
  pub(crate) const fn new(written: usize, status: StreamStatus) -> Self {
    Self { written, status }
  }
}