mbrotli 0.4.1

Fast Brotli (RFC 7932 and RFC 9841) compression and decompression in safe Rust; encoding is byte-identical to Google's reference encoder
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

//! Public-session ownership and error boundary over the shared block state machine.

use super::stream::{Buffers, Destination, Output, Phase, StreamState};
use crate::compressor::dictionary::PreparedDictionary;
use crate::compressor::encoder::Compressor;
use crate::compressor::error::EncodeError;
use crate::compressor::session::{Operation, Progress, StreamConfig};

/// Exclusive stream state over the compressor's retained buffers and encoder.
#[derive(Debug)]
pub(crate) struct SessionCore<'c, 'd> {
    compressor: &'c mut Compressor,
    dictionary: Option<&'d PreparedDictionary>,
    operation: OperationState,
}

/// Non-borrowing operation shared by raw guards and framed drivers.
#[derive(Debug)]
pub(crate) struct OperationState {
    state: StreamState,
    #[cfg(feature = "experimental")]
    logical_position: u64,
}

impl<'c, 'd> SessionCore<'c, 'd> {
    /// Starts after stream validation and workspace acquisition have succeeded.
    pub(crate) fn new(
        compressor: &'c mut Compressor,
        dictionary: Option<&'d PreparedDictionary>,
        limit: usize,
        stream: StreamConfig,
    ) -> Self {
        Self {
            compressor,
            dictionary,
            operation: OperationState::new(limit, stream),
        }
    }
    pub(crate) fn process(
        &mut self,
        input: &[u8],
        output: &mut [u8],
        operation: Operation,
    ) -> Result<Progress, EncodeError> {
        self.operation
            .process(self.compressor, self.dictionary, input, output, operation)
    }
    pub(crate) const fn is_finished(&self) -> bool {
        self.operation.is_finished(self.compressor)
    }
}

impl OperationState {
    pub(crate) fn new(limit: usize, stream: StreamConfig) -> Self {
        #[cfg(not(feature = "experimental"))]
        let _ = stream;
        Self {
            state: StreamState::new(
                limit,
                cfg!(feature = "experimental") && stream.stream_offset() != 0,
            ),
            #[cfg(feature = "experimental")]
            logical_position: stream.stream_offset(),
        }
    }

    /// Validates session state and logical positions, then runs the shared scheduler.
    pub(crate) fn process(
        &mut self,
        compressor: &mut Compressor,
        dictionary: Option<&PreparedDictionary>,
        input: &[u8],
        output: &mut [u8],
        operation: Operation,
    ) -> Result<Progress, EncodeError> {
        if self.state.phase == Phase::Failed {
            return Err(EncodeError::InvalidState {
                attempted: "process a stream that has already failed",
            });
        }
        #[cfg(feature = "experimental")]
        if self.state.phase != Phase::Finished
            && self
                .logical_position
                .checked_add(input.len() as u64)
                .is_none_or(|end| end > (1u64 << 63) - 1)
        {
            return Err(EncodeError::StreamPositionOverflow {
                position: self.logical_position,
                input_bytes: input.len() as u64,
            });
        }

        let Compressor {
            workspace,
            staging,
            pending,
            served,
            ..
        } = &mut *compressor;
        let Some(encoder) = workspace.encoder() else {
            self.state.phase = Phase::Failed;
            return Err(EncodeError::InternalInvariant {
                detail: "a session outlived the encoder it was started with",
            });
        };
        let outcome = self.state.process(
            encoder,
            dictionary.map(PreparedDictionary::inner),
            Buffers {
                staging,
                pending,
                served,
                allow_pending: true,
            },
            input,
            Output::new(Destination::Slice(output)),
            operation,
        );
        let progress = match outcome {
            Ok(progress) => progress,
            Err(error) => return Err(EncodeError::from_core(error, 0)),
        };
        #[cfg(feature = "experimental")]
        {
            self.logical_position += progress.consumed as u64;
        }
        Ok(progress)
    }

    /// Termination is observable only after all pending output was delivered.
    #[must_use]
    pub(crate) const fn is_finished(&self, compressor: &Compressor) -> bool {
        matches!(self.state.phase, Phase::Finished) && !compressor.has_pending()
    }
}

impl OperationState {
    pub(crate) fn release(&self, compressor: &mut Compressor) {
        if self.state.phase != Phase::Finished {
            compressor.workspace.invalidate();
        }
        compressor.staging.clear();
        compressor.pending.clear();
        compressor.served = 0;
        compressor.active = false;
        compressor.finish_operation();
    }
}

impl Drop for SessionCore<'_, '_> {
    fn drop(&mut self) {
        self.operation.release(self.compressor);
    }
}