pingora-cache 0.8.0

HTTP caching APIs for Pingora proxy.
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

// Copyright 2026 Cloudflare, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Set limit on the largest size to cache

use pingora_error::ErrorType;

/// Error type returned when the limit is reached.
pub const ERR_RESPONSE_TOO_LARGE: ErrorType = ErrorType::Custom("response too large");

// Body bytes tracker to adjust (predicted) cacheability,
// even if cache has been disabled.
#[derive(Debug)]
pub(crate) struct MaxFileSizeTracker {
    body_bytes: usize,
    max_size: usize,
}

impl MaxFileSizeTracker {
    // Create a new Tracker object.
    pub fn new(max_size: usize) -> MaxFileSizeTracker {
        MaxFileSizeTracker {
            body_bytes: 0,
            max_size,
        }
    }

    // Add bytes to the tracker.
    // If return value is true, the tracker bytes are under the max size allowed.
    pub fn add_body_bytes(&mut self, bytes: usize) -> bool {
        self.body_bytes += bytes;
        self.allow_caching()
    }

    pub fn max_file_size_bytes(&self) -> usize {
        self.max_size
    }

    pub fn allow_caching(&self) -> bool {
        self.body_bytes <= self.max_size
    }
}