aboutsummaryrefslogtreecommitdiff
path: root/pw_allocator/public/pw_allocator/null_allocator.h
blob: 55a7f62f4372871f340bb4d8c351393732557ec9 (plain)
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
// Copyright 2023 The Pigweed Authors
//
// 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
//
//     https://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.
#pragma once

#include "pw_allocator/allocator.h"

namespace pw::allocator {

/// A memory allocator that always fails to allocate memory.
///
/// A null allocator may be useful as part of a larger framework if allocation
/// should be disallowed under certain circumstances. For example, a function
/// that returns different allocators based on an input parameter may return a
/// null allocator when given an invalid or unsupported parameter value.
class NullAllocator : public Allocator {
 public:
  constexpr NullAllocator() = default;

 private:
  /// @copydoc Allocator::Allocate
  void* DoAllocate(size_t, size_t) override { return nullptr; }

  /// @copydoc Allocator::Deallocate
  void DoDeallocate(void*, size_t, size_t) override {}

  /// @copydoc Allocator::Resize
  bool DoResize(void*, size_t, size_t, size_t) override { return false; }
};

}  // namespace pw::allocator