Swift `Vec<primitive>` Return Type and Function Argument #229

timwedde · 2023-06-14T22:10:17Z

Fixes #228.

This enables the following use case:

// Rust
fn main() {
    let bytes = ffi::receive_bytes();
    println!("bytes: {:?}", bytes);

    let vec: Vec<u8> = vec![6, 1, 2, 3, 4, 5];
    ffi::send_bytes(vec);
}

#[swift_bridge::bridge]
mod ffi {
    extern "Swift" {
        fn receive_bytes() -> Vec<u8>;
        fn send_bytes(vec: Vec<u8>);
    }
}

// Swift
func send_bytes(vec: RustVec<UInt8>) {
    print("Received \(vec.len()) bytes from Rust")
    for val in vec {
        print(val)
    }
}

func receive_bytes() -> RustVec<UInt8> {
    let vec = RustVec<UInt8>()
    for i in 0 ... 4 {
        vec.push(value: UInt8(i))
    }
    return vec
}

This is chiefly intended for easy bidirectional byte exchanges but should work for all primitive types, at least the ones I tested with.

The codegen tests pass but I was unable to get the integration tests to run: They also fail for me on master and I don't understand enough of how they work to properly debug them. The (very long) error messages ends with this, which seems to be the culprit:

field has incomplete type 'struct swift_bridge$tuple$I32ResultTestOpaqueRustTypeString'

I attempted to add some integration tests for both directions anyway, but given that I'm operating 'blind' on that part I can't assure you whether these work or not.

I'm rather certain that there's still issues with my PR given that this is my first time dealing with this kind of interop work, so by all means do let me know how to address the current weaknesses/problems and I'll do my best to resolve them.

This exchanges raw pointers when: - send a Vec from Rust to Swift - receiving a Vec from Swift to Rust In all other cases the behavior is the same as before.

This adds test for both the argument and the return value variant.

Can't actually get these to run: The integration tests seem to already by broken. They fail with something to the tune of > field has incomplete type 'struct __swift_bridge__$tuple$I32ResultTestOpaqueRustTypeString'

NiwakaDev · 2023-06-14T23:26:59Z

@timwedde

field has incomplete type 'struct swift_bridge$tuple$I32ResultTestOpaqueRustTypeString'

This error is not due to this PR. If you want to know more detail, please see #225.

It seems like this PR is fine. Thanks!!

chinedufn

Thanks for the very detailed PR body.

This looks great to me. Left some very minor feedback then after that this is good to go.

chinedufn · 2023-06-15T22:45:11Z

SwiftRustIntegrationTestRunner/SwiftRustIntegrationTestRunner/Vec.swift

+//
+//  String.swift
+//  SwiftRustIntegrationTestRunner
+//
+//  Created by Frankie Nwafili on 2/18/22.
+//


You can delete this comment. Xcode typically auto generates them but we don't really need them

chinedufn · 2023-06-15T22:49:32Z

crates/swift-bridge-ir/src/codegen/codegen_tests/vec_codegen_tests.rs

+    }
+
+    fn expected_c_header() -> ExpectedCHeader {
+        ExpectedCHeader::ContainsAfterTrim("")


This will pass for all strings string all strings contain "".

You can use ExpectedCHeader::ExactAfterTrim("") here instead.

chinedufn · 2023-06-15T22:50:35Z

SwiftRustIntegrationTestRunner/SwiftRustIntegrationTestRunner/Vec.swift

+
+import Foundation
+
+func send_bytes(vec _: RustVec<UInt8>) {}


Lets call these swift_arg_vec_u8 and swift_return_vec_u8.

This way we can more easily distinguish these from other FFI functions.

chinedufn · 2023-06-15T22:51:01Z

SwiftRustIntegrationTestRunner/SwiftRustIntegrationTestRunner/Vec.swift

+
+import Foundation
+
+func send_bytes(vec _: RustVec<UInt8>) {}


Let's make this function assert that the bytes are 1, 2, 3, 4, 5

chinedufn · 2023-06-15T22:51:18Z

crates/swift-integration-tests/src/vec.rs

+    }
+}
+
+fn run_vec_tests() {


chinedufn · 2023-06-15T22:52:02Z

crates/swift-bridge-ir/src/codegen/codegen_tests/vec_codegen_tests.rs

+    }
+
+    fn expected_c_header() -> ExpectedCHeader {
+        ExpectedCHeader::ContainsAfterTrim("")


::ExactAfterTrim

chinedufn · 2023-06-15T22:52:40Z

crates/swift-integration-tests/src/vec.rs

@@ -25,6 +25,28 @@ mod ffi {
            arg: Vec<TransparentEnumInsideVecT>,
        ) -> Vec<TransparentEnumInsideVecT>;
    }
+
+    extern "Rust" {
+        fn run_vec_tests();


We need to call this on the Swift side in VecTests.rs

https://github.com/chinedufn/swift-bridge/blob/master/SwiftRustIntegrationTestRunner/SwiftRustIntegrationTestRunnerTests/VecTests.swift#L11

something like:

/// Verify that Rust can pass `RustVec`s to and receive `RustVec`s from Swift. func testRustCallsSwiftRustVecFunctions() { run_vec_tests() }

chinedufn · 2023-06-15T22:58:28Z

crates/swift-bridge-ir/src/bridged_type.rs

+                        } else {
+                            "UnsafeMutableRawPointer".to_string()
+                        }
+                    },


Need to run cargo fmt https://github.com/chinedufn/swift-bridge/actions/runs/5272573390/jobs/9561689835

Whoops, forgot about this one.

timwedde · 2023-06-17T14:36:18Z

Alright, I think I addressed all of the comments, let me know how I did 👍

chinedufn · 2023-06-19T19:47:43Z

Thanks!

chinedufn · 2023-06-20T17:16:13Z

A UI test is failing but I believe it's fixed in #230 so I'll merge this

timwedde added 3 commits June 14, 2023 23:15

Adjust IR representation

ed5db94

This exchanges raw pointers when: - send a Vec from Rust to Swift - receiving a Vec from Swift to Rust In all other cases the behavior is the same as before.

Add codegen tests

6dd5183

This adds test for both the argument and the return value variant.

Add integration tests

ebcabd7

Can't actually get these to run: The integration tests seem to already by broken. They fail with something to the tune of > field has incomplete type 'struct __swift_bridge__$tuple$I32ResultTestOpaqueRustTypeString'

chinedufn reviewed Jun 15, 2023

View reviewed changes

timwedde added 7 commits June 17, 2023 15:13

Remove autogenerated file header comment

2325ab9

Use more appropriate string comparison function

c1e3f0b

Use more descriptive function names in integration tests

dcef8a8

Assure Vec values in Swift using asserts

c592c1a

Use more appropriate string comparison function (again)

5dd4a48

Whoops, forgot about this one.

Call test function from the Swift side as well

f5fe768

cargo fmt run

9d9abd0

chinedufn approved these changes Jun 19, 2023

View reviewed changes

chinedufn merged commit ffe20d8 into chinedufn:master Jun 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swift `Vec<primitive>` Return Type and Function Argument #229

Swift `Vec<primitive>` Return Type and Function Argument #229

timwedde commented Jun 14, 2023

NiwakaDev commented Jun 14, 2023 •

edited

Loading

chinedufn left a comment

chinedufn Jun 15, 2023

chinedufn Jun 15, 2023

chinedufn Jun 15, 2023

chinedufn Jun 15, 2023

chinedufn Jun 15, 2023

chinedufn Jun 15, 2023

chinedufn Jun 15, 2023

chinedufn Jun 15, 2023

chinedufn Jun 15, 2023

timwedde commented Jun 17, 2023

chinedufn commented Jun 19, 2023

chinedufn commented Jun 20, 2023

Swift Vec<primitive> Return Type and Function Argument #229

Swift Vec<primitive> Return Type and Function Argument #229

Conversation

timwedde commented Jun 14, 2023

NiwakaDev commented Jun 14, 2023 • edited Loading

chinedufn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timwedde commented Jun 17, 2023

chinedufn commented Jun 19, 2023

chinedufn commented Jun 20, 2023

Swift `Vec<primitive>` Return Type and Function Argument #229

Swift `Vec<primitive>` Return Type and Function Argument #229

NiwakaDev commented Jun 14, 2023 •

edited

Loading