Merge pull request #1 from kuecks/issue_87_option

Bindings for Option and std::optional

Author: kuecks

book/src/SUMMARY.md

@@ -32,6 +32,7 @@
     - [SharedPtr\<T\> &mdash; std::shared\_ptr\<T\>](binding/sharedptr.md)
     - [Vec\<T\> &mdash; rust::Vec\<T\>](binding/vec.md)
     - [CxxVector\<T\> &mdash; std::vector\<T\>](binding/cxxvector.md)
+    - [Option\<T\> &mdash; rust::Option\<T\>](binding/option.md)
     - [*mut T, *const T raw pointers](binding/rawptr.md)
     - [Function pointers](binding/fn.md)
     - [Result\<T\>](binding/result.md)

book/src/binding/option.md

@@ -0,0 +1,89 @@
+{{#title rust::Option<T> — Rust ♡ C++}}
+# rust::Option\<T\>
+
+### Public API:
+
+```cpp,hidelines=...
+// rust/cxx.h
+...
+...namespace rust {
+
+template <typename T>
+class Option final {
+public:
+  Option() noexcept;
+  Option(Option&&) noexcept;
+  Option(T&&) noexcept;
+  ~Option() noexcept;
+
+  const T *operator->() const;
+  const T &operator*() const;
+  T *operator->();
+  T &operator*();
+
+  Option<T>& operator=(Option&&) noexcept;
+
+  bool has_value() const noexcept;
+  T& value() noexcept;
+  void reset();
+  void set(T&&) noexcept;
+};
+...} // namespace rust
+```
+
+### Restrictions:
+
+Option<T> only supports pointer-sized references and Box-es; that is, no
+fat pointers like &str (though &String is supported) or Box<[u8]>. On the
+C++ side, Option<&T> becomes rust::Option<const T*> (and similar for
+mutable references), but the pointer is guaranteed to be non-null if the
+Option has a value. Also, you can only pass Options themselves by value.
+&Option<T> is not allowed.
+
+## Example
+
+```rust,noplayground
+// src/main.rs
+
+#[cxx::bridge]
+mod ffi {
+    struct Shared {
+        v: u32,
+    }
+
+    unsafe extern "C++" {
+        include!("example/include/example.h");
+
+        fn f(elements: Option<&Shared>);
+    }
+}
+
+fn main() {
+    let shared = Shared { v: 3 };
+    ffi::f(Some(&shared));
+    ffi::f(None);
+}
+```
+
+```cpp
+// include/example.h
+
+#pragma once
+#include "example/src/main.rs.h"
+#include "rust/cxx.h"
+
+void f(rust::Option<const Shared*>);
+```
+
+```cpp
+// src/example.cc
+
+#include "example/include/example.h"
+
+void f(rust::Option<const Shared*> o) {
+  if (o.has_value()) {
+    // Pointer is guaranteed to be non-null
+    std::cout << shared.value()->v << std::endl;
+  }
+}
+```

gen/src/builtin.rs

@@ -10,6 +10,7 @@ pub(crate) struct Builtins<'a> {
     pub rust_slice: bool,
     pub rust_box: bool,
     pub rust_vec: bool,
+    pub rust_option: bool,
     pub rust_fn: bool,
     pub rust_isize: bool,
     pub opaque: bool,