lib/wlan/common/include/wlan/common/element_splitter.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef GARNET_LIB_WLAN_COMMON_INCLUDE_WLAN_COMMON_ELEMENT_SPLITTER_H_
#define GARNET_LIB_WLAN_COMMON_INCLUDE_WLAN_COMMON_ELEMENT_SPLITTER_H_

#include <wlan/common/element_id.h>
#include <wlan/common/span.h>

#include <tuple>

namespace wlan {
namespace common {

class ElementIterator;

bool operator== (const ElementIterator& a, const ElementIterator& b);
bool operator!= (const ElementIterator& a, const ElementIterator& b);

class ElementIterator {
 public:
    friend bool wlan::common::operator==(const ElementIterator& a, const ElementIterator& b);
    friend bool wlan::common::operator!=(const ElementIterator& a, const ElementIterator& b);

    explicit ElementIterator(Span<const uint8_t> buffer);

    std::tuple<element_id::ElementId, Span<const uint8_t>> operator* () const;

    ElementIterator& operator++();

 private:
    Span<const uint8_t> remaining_;
};

class ElementSplitter {
 public:
    explicit ElementSplitter(Span<const uint8_t> buffer) : buffer_(buffer) {}

    ElementIterator begin() const {
        return ElementIterator(buffer_);
    }

    ElementIterator end() const {
        return ElementIterator(buffer_.subspan(buffer_.size()));
    }

 private:
    Span<const uint8_t> buffer_;
};

} // namespace common
} // namespace wlan

#endif // GARNET_LIB_WLAN_COMMON_INCLUDE_WLAN_COMMON_ELEMENT_SPLITTER_H_