ColdClass.h 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. /*
  2. * Copyright 2017-present Facebook, Inc.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. /* Tag any class as `cold` by inheriting from folly::cold::ColdClass
  17. *
  18. * Intended use: things like folly::Unexpected which are designed to only be
  19. * instantiated on error paths.
  20. */
  21. #pragma once
  22. #include <folly/CppAttributes.h>
  23. namespace folly {
  24. // ColdClass should be in its own namespace: inheriting from any class adds its
  25. // innermost namespace to the namespaces inspected during
  26. // argument-dependent-lookoup. We want people to be able to derive from this
  27. // without implicitly picking up the folly namespace for ADL on their classes.
  28. namespace cold_detail {
  29. struct ColdClass {
  30. FOLLY_COLD ColdClass() noexcept;
  31. };
  32. } // namespace cold_detail
  33. /* using override */ using cold_detail::ColdClass;
  34. } // namespace folly