flapigen 0.11.0

Tool for connecting libraries written in Rust with other languages
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

#pragma once

#include <cstddef> //ptrdiff_t
#include <cassert>
#include <iterator>

template <typename T> class RustForeignSliceIterator final {
public:
    using iterator_category = std::random_access_iterator_tag;
    using value_type = T;
    using difference_type = std::ptrdiff_t;
    using pointer = const T *;
    using reference = T;

    using CForeignType = typename T::CForeignType;

    RustForeignSliceIterator() noexcept
        : ptr(nullptr)
        , step(0)
    {
    }
    RustForeignSliceIterator(const void *p, size_t s) noexcept
        : ptr(p)
        , step(s)
    {
    }

    /**
     * \defgroup Forward iterator requirements
     */
    /*@{*/
    T operator*() const noexcept
    {
        auto elem_ptr = static_cast<const CForeignType *>(this->ptr);
        return T{ elem_ptr };
    }

    RustForeignSliceIterator &operator++() noexcept
    {
        this->ptr = static_cast<const uint8_t *>(this->ptr) + this->step;
        return *this;
    }
    /*@}*/

    /**
     * \defgroup Bidirectional iterator requirements
     */
    /*@{*/
    RustForeignSliceIterator &operator--() noexcept
    {
        this->ptr = static_cast<const uint8_t *>(this->ptr) - this->step;
        return *this;
    }
    /*@}*/
    /**
     * \defgroup Random access iterator requirements
     */
    /*@{*/
    T operator[](ptrdiff_t n) const noexcept
    {
        auto p = static_cast<const uint8_t *>(this->ptr) + n * this->step;
        auto elem_ptr = static_cast<const CForeignType *>(p);
        return T{ elem_ptr };
    }

    RustForeignSliceIterator &operator+=(ptrdiff_t n) noexcept
    {
        this->ptr = static_cast<const uint8_t *>(this->ptr) + n * this->step;
        return *this;
    }

    RustForeignSliceIterator operator+(ptrdiff_t n) const noexcept
    {
        const void *p = static_cast<const uint8_t *>(this->ptr) + n * this->step;
        return RustForeignSliceIterator(p, this->step);
    }

    RustForeignSliceIterator &operator-=(ptrdiff_t n) noexcept
    {
        this->ptr = static_cast<const uint8_t *>(this->ptr) - n * this->step;
        return *this;
    }

    RustForeignSliceIterator operator-(ptrdiff_t n) const noexcept
    {
        const void *p = static_cast<const uint8_t *>(this->ptr) - n * this->step;
        return RustForeignSliceIterator(p, this->step);
    }

    ptrdiff_t operator-(const RustForeignSliceIterator &o) const noexcept
    {
        assert(this->step == o.step);
        ptrdiff_t diff
            = static_cast<const uint8_t *>(this->ptr) - static_cast<const uint8_t *>(o.ptr);
        // if container empty step may be 0, to prevent div by 0
        if (diff != 0) {
            return diff / this->step;
        }
        else {
            return 0;
        }
    }

    bool operator<(const RustForeignSliceIterator &o) const noexcept
    {
        assert(this->step == o.step);
        return this->ptr < o.ptr;
    }

    bool operator>(const RustForeignSliceIterator &o) const noexcept
    {
        assert(this->step == o.step);
        return this->ptr > o.ptr;
    }

    bool operator<=(const RustForeignSliceIterator &o) const noexcept { return !operator>(o); }

    bool operator>=(const RustForeignSliceIterator &o) const noexcept { return !operator<(o); }
    /*@}*/

    bool operator==(const RustForeignSliceIterator<T> &o) const noexcept
    {
        assert(this->step == o.step);
        return this->ptr == o.ptr;
    }
    bool operator!=(const RustForeignSliceIterator<T> &o) const noexcept { return !operator==(o); }

private:
    const void *ptr;
    uintptr_t step;
};