LCOV - code coverage report
Current view: top level - lib/support - Defer.h (source / functions) Hit Total Coverage
Test: lcov_final.info Lines: 4 4 100.0 %
Date: 2024-02-15 08:20:41 Functions: 6 6 100.0 %

          Line data    Source code
       1             : /*
       2             :  *
       3             :  *    Copyright (c) 2021 Project CHIP Authors
       4             :  *    All rights reserved.
       5             :  *
       6             :  *    Licensed under the Apache License, Version 2.0 (the "License");
       7             :  *    you may not use this file except in compliance with the License.
       8             :  *    You may obtain a copy of the License at
       9             :  *
      10             :  *        http://www.apache.org/licenses/LICENSE-2.0
      11             :  *
      12             :  *    Unless required by applicable law or agreed to in writing, software
      13             :  *    distributed under the License is distributed on an "AS IS" BASIS,
      14             :  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      15             :  *    See the License for the specific language governing permissions and
      16             :  *    limitations under the License.
      17             :  */
      18             : 
      19             : #pragma once
      20             : 
      21             : #include <utility>
      22             : 
      23             : template <typename Function>
      24             : class Defer
      25             : {
      26             : public:
      27        9430 :     Defer(Function && function) : mFunction(std::move(function)) {}
      28        9430 :     ~Defer() { mFunction(); }
      29             : 
      30             :     Defer(Defer & that)              = default;
      31             :     Defer & operator=(Defer & that)  = default;
      32             :     Defer(Defer && that)             = default;
      33             :     Defer & operator=(Defer && that) = default;
      34             : 
      35             : private:
      36             :     Function mFunction;
      37             : };
      38             : 
      39             : /**
      40             :  * @brief
      41             :  *   Defers the execution of a function until the surrounding function returns.
      42             :  *   Create a Defer object holding a lambda:
      43             :  *
      44             :  *     auto deferred = MakeDefer([]() { -- do cleanup -- });
      45             :  *
      46             :  *   The lambda will be called as soon as the object goes out of scope.
      47             :  */
      48             : template <typename Function>
      49        9430 : Defer<Function> MakeDefer(Function && function)
      50             : {
      51        9430 :     return Defer<Function>(std::forward<Function>(function));
      52             : }

Generated by: LCOV version 1.14