src/lib/support/Span.h

   1 /*
   2  *
   3  *    Copyright (c) 2021 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, software
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 #include <cstdint>
  21 #include <cstdlib>
  22
  23 namespace chip {
  24
  25 /**
  26  * @brief A wrapper class for holding objects and its length, without the ownership of it.
  27  * We can use C++20 std::span once we support it, the data() and size() come from C++20 std::span.
  28  */
  29 template <class T>
  30 class Span
  31 {
  32 public:
  33     Span() : mDataBuf(nullptr), mDataLen(0) {}
  34     Span(const T * databuf, size_t datalen) : mDataBuf(databuf), mDataLen(datalen) {}
  35
  36     const T * data() const { return mDataBuf; }
  37     size_t size() const { return mDataLen; }
  38
  39 private:
  40     const T * mDataBuf;
  41     size_t mDataLen;
  42 };
  43
  44 using ByteSpan = Span<uint8_t>;
  45
  46 } // namespace chip