Skip to content

Rename rust::Slice<T> to rust::Slice<const T> #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2020
Merged

Rename rust::Slice<T> to rust::Slice<const T> #453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ returns of functions.
<tr><th>name in Rust</th><th>name in C++</th><th>restrictions</th></tr>
<tr><td>String</td><td>rust::String</td><td></td></tr>
<tr><td>&amp;str</td><td>rust::Str</td><td></td></tr>
<tr><td>&amp;[u8]</td><td>rust::Slice&lt;uint8_t&gt;</td><td><sup><i>arbitrary &amp;[T] not implemented yet</i></sup></td></tr>
<tr><td>&amp;[u8]</td><td>rust::Slice&lt;const uint8_t&gt;</td><td><sup><i>arbitrary &amp;[T] not implemented yet</i></sup></td></tr>
<tr><td><a href="https://docs.rs/cxx/0.5/cxx/struct.CxxString.html">CxxString</a></td><td>std::string</td><td><sup><i>cannot be passed by value</i></sup></td></tr>
<tr><td>Box&lt;T&gt;</td><td>rust::Box&lt;T&gt;</td><td><sup><i>cannot hold opaque C++ type</i></sup></td></tr>
<tr><td><a href="https://docs.rs/cxx/0.5/cxx/struct.UniquePtr.html">UniquePtr&lt;T&gt;</a></td><td>std::unique_ptr&lt;T&gt;</td><td><sup><i>cannot hold opaque Rust type</i></sup></td></tr>
Expand Down
10 changes: 5 additions & 5 deletions gen/src/write.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ fn write_cxx_function_shim<'a>(out: &mut OutFile<'a>, efn: &'a ExternFn) {
}
Some(Type::SliceRefU8(_)) if !indirect_return => {
out.builtin.rust_slice_repr = true;
write!(out, "::rust::impl<::rust::Slice<uint8_t>>::repr(")
write!(out, "::rust::impl<::rust::Slice<const uint8_t>>::repr(")
}
_ => {}
}
Expand Down Expand Up @@ -471,7 +471,7 @@ fn write_cxx_function_shim<'a>(out: &mut OutFile<'a>, efn: &'a ExternFn) {
} else if let Type::SliceRefU8(_) = arg.ty {
write!(
out,
"::rust::Slice<uint8_t>(static_cast<const uint8_t *>({0}.ptr), {0}.len)",
"::rust::Slice<const uint8_t>(static_cast<const uint8_t *>({0}.ptr), {0}.len)",
arg.ident,
);
} else if out.types.needs_indirect_abi(&arg.ty) {
Expand Down Expand Up @@ -688,7 +688,7 @@ fn write_rust_function_shim_impl(
}
Type::SliceRefU8(_) => {
out.builtin.rust_slice_new = true;
write!(out, "::rust::impl<::rust::Slice<uint8_t>>::slice(");
write!(out, "::rust::impl<::rust::Slice<const uint8_t>>::slice(");
}
_ => {}
}
Expand All @@ -714,7 +714,7 @@ fn write_rust_function_shim_impl(
}
Type::SliceRefU8(_) => {
out.builtin.rust_slice_repr = true;
write!(out, "::rust::impl<::rust::Slice<uint8_t>>::repr(");
write!(out, "::rust::impl<::rust::Slice<const uint8_t>>::repr(");
}
ty if out.types.needs_indirect_abi(ty) => write!(out, "&"),
_ => {}
Expand Down Expand Up @@ -885,7 +885,7 @@ fn write_type(out: &mut OutFile, ty: &Type) {
write!(out, "::rust::Str");
}
Type::SliceRefU8(_) => {
write!(out, "::rust::Slice<uint8_t>");
write!(out, "::rust::Slice<const uint8_t>");
}
Type::Fn(f) => {
write!(out, "::rust::{}<", if f.throws { "TryFn" } else { "Fn" });
Expand Down
15 changes: 9 additions & 6 deletions include/cxx.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,16 @@ class Str final {
#ifndef CXXBRIDGE05_RUST_SLICE
template <typename T>
class Slice final {
static_assert(std::is_const<T>::value,
"&[T] needs to be written as rust::Slice<const T> in C++");

public:
Slice() noexcept;
Slice(const T *, size_t count) noexcept;
Slice(T *, size_t count) noexcept;

Slice &operator=(const Slice<T> &) noexcept = default;

const T *data() const noexcept;
T *data() const noexcept;
size_t size() const noexcept;
size_t length() const noexcept;

Expand All @@ -108,7 +111,7 @@ class Slice final {
friend impl<Slice>;
// Not necessarily ABI compatible with &[T]. Codegen will translate to
// cxx::rust_sliceu8::RustSliceU8 which matches this layout.
const T *ptr;
T *ptr;
size_t len;
};
#endif // CXXBRIDGE05_RUST_SLICE
Expand Down Expand Up @@ -358,13 +361,13 @@ inline size_t Str::length() const noexcept { return this->len; }
#ifndef CXXBRIDGE05_RUST_SLICE
#define CXXBRIDGE05_RUST_SLICE
template <typename T>
Slice<T>::Slice() noexcept : ptr(reinterpret_cast<const T *>(this)), len(0) {}
Slice<T>::Slice() noexcept : ptr(reinterpret_cast<T *>(this)), len(0) {}

template <typename T>
Slice<T>::Slice(const T *s, size_t count) noexcept : ptr(s), len(count) {}
Slice<T>::Slice(T *s, size_t count) noexcept : ptr(s), len(count) {}

template <typename T>
const T *Slice<T>::data() const noexcept {
T *Slice<T>::data() const noexcept {
return this->ptr;
}

Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@
//! <tr><th>name in Rust</th><th>name in C++</th><th>restrictions</th></tr>
//! <tr><td>String</td><td>rust::String</td><td></td></tr>
//! <tr><td>&amp;str</td><td>rust::Str</td><td></td></tr>
//! <tr><td>&amp;[u8]</td><td>rust::Slice&lt;uint8_t&gt;</td><td><sup><i>arbitrary &amp;[T] not implemented yet</i></sup></td></tr>
//! <tr><td>&amp;[u8]</td><td>rust::Slice&lt;const uint8_t&gt;</td><td><sup><i>arbitrary &amp;[T] not implemented yet</i></sup></td></tr>
//! <tr><td><a href="struct.CxxString.html">CxxString</a></td><td>std::string</td><td><sup><i>cannot be passed by value</i></sup></td></tr>
//! <tr><td>Box&lt;T&gt;</td><td>rust::Box&lt;T&gt;</td><td><sup><i>cannot hold opaque C++ type</i></sup></td></tr>
//! <tr><td><a href="struct.UniquePtr.html">UniquePtr&lt;T&gt;</a></td><td>std::unique_ptr&lt;T&gt;</td><td><sup><i>cannot hold opaque Rust type</i></sup></td></tr>
Expand Down
14 changes: 8 additions & 6 deletions tests/ffi/tests.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ rust::Str c_return_str(const Shared &shared) {
return "2020";
}

rust::Slice<uint8_t> c_return_sliceu8(const Shared &shared) {
rust::Slice<const uint8_t> c_return_sliceu8(const Shared &shared) {
(void)shared;
return rust::Slice<uint8_t>(reinterpret_cast<const uint8_t *>(SLICE_DATA),
sizeof(SLICE_DATA));
return rust::Slice<const uint8_t>(
reinterpret_cast<const uint8_t *>(SLICE_DATA), sizeof(SLICE_DATA));
}

rust::String c_return_rust_string() { return "2020"; }
Expand Down Expand Up @@ -240,7 +240,7 @@ void c_take_str(rust::Str s) {
}
}

void c_take_sliceu8(rust::Slice<uint8_t> s) {
void c_take_sliceu8(rust::Slice<const uint8_t> s) {
if (std::string(reinterpret_cast<const char *>(s.data()), s.size()) ==
"2020") {
cxx_test_suite_set_correct();
Expand Down Expand Up @@ -436,7 +436,9 @@ const rust::String &c_try_return_ref(const rust::String &s) { return s; }

rust::Str c_try_return_str(rust::Str s) { return s; }

rust::Slice<uint8_t> c_try_return_sliceu8(rust::Slice<uint8_t> s) { return s; }
rust::Slice<const uint8_t> c_try_return_sliceu8(rust::Slice<const uint8_t> s) {
return s;
}

rust::String c_try_return_rust_string() { return c_return_rust_string(); }

Expand Down Expand Up @@ -608,7 +610,7 @@ extern "C" const char *cxx_run_test() noexcept {
r_take_unique_ptr(std::unique_ptr<C>(new C{2020}));
r_take_ref_c(C{2020});
r_take_str(rust::Str("2020"));
r_take_sliceu8(rust::Slice<uint8_t>(
r_take_sliceu8(rust::Slice<const uint8_t>(
reinterpret_cast<const uint8_t *>(SLICE_DATA), sizeof(SLICE_DATA)));
r_take_rust_string(rust::String("2020"));
r_take_unique_ptr_string(
Expand Down
6 changes: 3 additions & 3 deletions tests/ffi/tests.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ const size_t &c_return_ns_ref(const ::A::AShared &shared);
const size_t &c_return_nested_ns_ref(const ::A::B::ABShared &shared);
size_t &c_return_mut(Shared &shared);
rust::Str c_return_str(const Shared &shared);
rust::Slice<uint8_t> c_return_sliceu8(const Shared &shared);
rust::Slice<const uint8_t> c_return_sliceu8(const Shared &shared);
rust::String c_return_rust_string();
std::unique_ptr<std::string> c_return_unique_ptr_string();
std::unique_ptr<std::vector<uint8_t>> c_return_unique_ptr_vector_u8();
Expand Down Expand Up @@ -114,7 +114,7 @@ void c_take_ref_r(const R &r);
void c_take_ref_c(const C &c);
void c_take_ref_ns_c(const ::H::H &h);
void c_take_str(rust::Str s);
void c_take_sliceu8(rust::Slice<uint8_t> s);
void c_take_sliceu8(rust::Slice<const uint8_t> s);
void c_take_rust_string(rust::String s);
void c_take_unique_ptr_string(std::unique_ptr<std::string> s);
void c_take_unique_ptr_vector_u8(std::unique_ptr<std::vector<uint8_t>> v);
Expand Down Expand Up @@ -148,7 +148,7 @@ size_t c_fail_return_primitive();
rust::Box<R> c_try_return_box();
const rust::String &c_try_return_ref(const rust::String &);
rust::Str c_try_return_str(rust::Str);
rust::Slice<uint8_t> c_try_return_sliceu8(rust::Slice<uint8_t>);
rust::Slice<const uint8_t> c_try_return_sliceu8(rust::Slice<const uint8_t>);
rust::String c_try_return_rust_string();
std::unique_ptr<std::string> c_try_return_unique_ptr_string();
rust::Vec<uint8_t> c_try_return_rust_vec();
Expand Down