我应该如何在 API 中替换 vector<uint8_t>::const_iterator？

Question

我的任务是完善编解码器库的界面。我们使用的是 C++17，我只能使用标准库（即没有 Boost）。目前，有一个Decoder 类，大致如下：

class Decoder : public Codec {

public:

    struct Result {
        vector<uint8_t>::const_iterator new_buffer_begin;
        optional<Metadata>              metadata;
        optional<Packet>                packet;
    };

    Result decode(vector<uint8_t>::const_iterator buffer_begin,
                  vector<uint8_t>::const_iterator buffer_end);

private:
    // irrelevant details
};

调用者实例化一个Decoder，然后通过

向解码器提供一个数据流

1. 从文件中读取一大块数据（但将来可能会有其他来源），并将其附加到vector<uint8_t>。

2. 调用decode 函数，传递其向量的迭代器。

3. 如果返回的Result 的new_buffer_begin 与传递给decode 的buffer_begin 相同，这意味着缓冲区中没有足够的数据来解码任何内容，调用者应该返回第 1 步。否则，调用者会使用已解码的 Metadata 或 Packet 对象，并返回第 2 步，使用 new_buffer_begin 进行下一次传递。

我不喜欢这个界面并需要帮助改进的地方：

• 使用vector<uint8_t>::const_iterator 似乎过于具体。有没有更通用的方法不强制调用者使用vector？我正在考虑只使用 C 风格的界面； uint8_t * 和长度。有没有相当通用的 C++ 替代方案？

• 如果有足够的数据来解码某些东西，那么只有metadata 或 packet 会有一个值。我认为std::variant 或 2 个回调（每种类型一个）将使此代码更具自我记录性。我不确定哪个更惯用。各有什么优缺点，有没有更好的方法？

Answer 1

我同意强制使用 vector 是不恰当的，并赞赏您尝试使界面更有用的尝试。

如果decode 需要一个连续的uint8_t 序列，那么久经考验（也是最灵活）的解决方案就是采用const uint8_t* 和std::size_t（或者两个指针，但指针和长度更惯用）。

从 C++20 开始，您可以使用 std::span<const uint8_t> 类型的一个参数来执行此操作。或者回到指针，如果你真的想为此使用现代库工具，你可以用std::experimental::observer_ptr混淆人们。

您也可以考虑将decode 设为接受任何迭代器对的模板，并且（如果需要连续性）强制要求迭代器反映连续 序列，即使仅通过文档也是如此。但是，将所有内容都制作成模板并不总是您想要的，而且它并不总是有用的。

Answer 2

除了@Justin 对spans 的有效建议：

• 您可能还想考虑使用std::byte 而不是uint8_t，所以：

  Result decode(std::span<const std::byte> buffer);
  

  或者如果您使用 C++17，请使用来自 C++ Guidelines Support library 的 span 实现：

  #include <gsl/span>
  // etc.
  Result decode(gsl::span<const std::byte> buffer);
  

• 如果您想支持从原始内存以外的容器进行解码，请使用任意迭代器（在 C++17 和更早版本中）或可能的范围（在 C++20 中）。迭代器版本：

  template <typename InputIt>
  Result decode(InputIt start, InputIt end) { /* etc. */ }
  

• Decoder 继承自 Codec 而不是相反，这很可疑。

• 回调是否是一个好的选择这个问题是（对我来说）在没有看到代码的情况下很难回答的问题。但确实使用std::variant 来表达您拥有数据包或元数据的事实；如果您使用变体 std::visit 而不是回调，您也可以“组合”替代方案。

Answer 3

C++20 将有 std::span，它可以满足您的需求：

    Result decode(std::span<uint8_t const> buffer);

std::span<T> 在语义上等同于T* buffer, size_t size。

---

在 C++17 中，有一些 span 类型的实现等价于 std::span，例如 GSL's gsl::span。见What is a "span" and when should I use one?。

如果您不能使用任何外部库，请考虑编写自己的 span 类型，否则 uint8_t const* buffer_begin, uint8_t const* buffer_end 可以工作。