Skip to main content

common_recordbatch/
memory.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Scan memory reservations held for reader lifetimes.
16
17use common_memory_manager::MemoryGuard;
18
19use crate::CallbackMemoryMetrics;
20
21/// Reserved scan memory, released automatically on drop.
22#[derive(Debug)]
23pub struct QueryMemoryReservation {
24    pub(crate) inner: MemoryGuard<CallbackMemoryMetrics>,
25}
26
27impl QueryMemoryReservation {
28    pub(crate) fn try_acquire_additional(&mut self, bytes: u64) -> bool {
29        self.inner.try_acquire_additional(bytes)
30    }
31}