memory_view.hpp

Go to the documentation of this file.

/*
 * Copyright © 2018 Max Mazurov (fox.cpp) <fox.cpp [at] disroot [dot] org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#pragma once

#include <cstddef>
#include <cstdint>
#include <iterator>

/*
 * If you had to open this file to find answer for your question - we are so
 * sorry. Please open issue with your question so we can update documentation
 * to answer it.
 */

#ifdef __cpp_exceptions
#    define LIBWIRE_EXCEPTIONS_ENABLED_BOOL true
#else
#    define LIBWIRE_EXCEPTIONS_ENABLED_BOOL false
#endif

namespace libwire {
    class memory_view {
    public:
        using value_type = uint8_t;
        using size_type = size_t;
        using difference_type = std::ptrdiff_t;
        using reference = value_type&;
        using const_reference = const value_type&;
        using pointer = value_type*;
        using const_pointer = const pointer;
        using iterator = pointer;
        using const_iterator = const_pointer;
        using reverse_iterator = std::reverse_iterator<iterator>;
        using const_reverse_iterator = std::reverse_iterator<iterator>;

        memory_view() noexcept;
        memory_view(void* memory, size_t size_bytes) noexcept;

#ifdef __cpp_exceptions
        const_reference at(size_t) const;
#endif
        const_reference operator[](size_t) const noexcept;

#ifdef __cpp_exceptions
        reference at(size_t);
#endif
        reference operator[](size_t) noexcept;

        const_reference front() const noexcept;
        const_reference back() const noexcept;

        reference front() noexcept;
        reference back() noexcept;

        const_pointer data() const noexcept;
        pointer data() noexcept;

        const_iterator begin() const noexcept;
        const_iterator end() const noexcept;

        iterator begin() noexcept;
        iterator end() noexcept;

        const_iterator cbegin() const noexcept;
        const_iterator cend() const noexcept;

        size_type size() const noexcept;

        size_type max_size() const noexcept;

        size_type capacity() const noexcept;

        void shrink_back(size_type bytes_count) noexcept;

        void shrink_front(size_type bytes_count) noexcept;

        void clear() noexcept;

        void resize(size_t new_size) noexcept(!LIBWIRE_EXCEPTIONS_ENABLED_BOOL);

        void swap(memory_view& other) noexcept;

    private:
        uint8_t* data_;
        size_t size_;
        size_t capacity_;
    };
} // namespace libwire