使用 FFI 将字符串从 C# 传递到 Rust
Pass string from C# to Rust using FFI
我尝试将 string
作为函数参数传递给 Rust 库 (cdylib
),如 Rust FFI Omnibus.
中所述
我试图省略 libc
依赖项,因为我认为它不再是必需的。
我正在使用 Rust 1.50.0
和 .net 5.0.103
.
从文档来看,在我看来,CStr::from_ptr()
函数通过读取所有字节直到 null-termination[=59= 从指针构造一个 CStr
].并且 C# 字符串会自动编组为 C 兼容字符串(因此以 null 结尾)。然而,我的问题是,我没有得到作为函数参数提供的完整字符串,而是只得到第一个字符作为字符串。
这是我的 lib.rs
:
use std::os::raw::c_char;
use std::ffi::CStr;
#[no_mangle]
pub extern fn print_string(text_pointer: *const c_char) {
unsafe {
let text: String = CStr::from_ptr(text_pointer).to_str().expect("Can not read string argument.").to_string();
println!("{}", text);
}
}
和我的 Cargo.toml
:
[package]
name = "mylib"
version = "0.1.0"
authors = ["FrankenApps"]
edition = "2018"
[lib]
crate-type = ["cdylib"]
这是我的 C# 代码:
using System;
using System.Runtime.InteropServices;
namespace dotnet
{
class Program
{
[DllImport("mylib.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern void print_string(string text);
static void Main(string[] args)
{
print_string("Hello World.");
}
}
}
在这种情况下,我运行程序的输出是:
H
当我 运行 链接示例时,出现错误:
thread '<unnamed>' panicked at 'called `Result::unwrap()` on an `Err` value: Utf8Error { valid_up_to: 1, error_len: Some(1) }', src\lib.rs:12:32
然而,当我只使用 ASCII 字符并修改代码时:
生锈:
use libc::c_char;
use std::ffi::CStr;
#[no_mangle]
pub extern "C" fn how_many_characters(s: *const c_char) -> u32 {
let c_str = unsafe {
assert!(!s.is_null());
CStr::from_ptr(s)
};
let r_str = c_str.to_str().unwrap();
println!("{}", r_str.to_string());
r_str.chars().count() as u32
}
C#
using System;
using System.Runtime.InteropServices;
class StringArguments
{
[DllImport("mylib", EntryPoint="how_many_characters")]
public static extern uint HowManyCharacters(string s);
static public void Main()
{
var count = StringArguments.HowManyCharacters("Hello World.");
Console.WriteLine(count);
}
}
我得到了想要的输出:
Hello World.
12
我的问题是我在自己的样本中做错了什么,我试图不使用 libc
? libc 和标准库中的 c_char
之间是否有任何区别,使它们的行为不同?
我猜我漏掉了一些简单的东西,因为我确实希望它能起作用...
您需要使用 CharSet = CharSet.Ansi
,这似乎是默认设置。
当我替换
[DllImport("mylib.dll", CharSet = CharSet.Unicode, SetLastError = true)]
和
[DllImport("mylib.dll", CharSet = CharSet.Ansi, SetLastError = true)]
我确实得到了输出:
Hello World.
如果能以某种方式支持 unicode 字符串,那就太好了。
编辑
我想出了如何使用 UTF-8 字符串。我没有更改 Rust 实现中的任何内容,但不是在 C# 中自动编组 string
,而是在 C# 中使用 UTF-8 编码字节数组作为函数参数:
using System;
using System.Runtime.InteropServices;
namespace dotnet
{
class Program
{
[DllImport("mylib.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern void print_string(byte[] utf8Text);
static void Main(string[] args)
{
print_string(Encoding.UTF8.GetBytes("göes to élevên"));
}
}
}
这完美地工作并打印:
göes to élevên
从 .NET 4.7 开始,您可以使用 MarshalAs(UnmanagedType.LPUTF8Str)
,因此以下内容应该可以正常工作:
using System.Runtime.InteropServices;
namespace dotnet
{
class Program
{
[DllImport("mylib.dll")]
public static extern void print_string([MarshalAs(UnmanagedType.LPUTF8Str)] string utf8Text);
static void Main(string[] args)
{
print_string("göes to élevên");
}
}
}
我尝试将 string
作为函数参数传递给 Rust 库 (cdylib
),如 Rust FFI Omnibus.
我试图省略 libc
依赖项,因为我认为它不再是必需的。
我正在使用 Rust 1.50.0
和 .net 5.0.103
.
从文档来看,在我看来,CStr::from_ptr()
函数通过读取所有字节直到 null-termination[=59= 从指针构造一个 CStr
].并且 C# 字符串会自动编组为 C 兼容字符串(因此以 null 结尾)。然而,我的问题是,我没有得到作为函数参数提供的完整字符串,而是只得到第一个字符作为字符串。
这是我的 lib.rs
:
use std::os::raw::c_char;
use std::ffi::CStr;
#[no_mangle]
pub extern fn print_string(text_pointer: *const c_char) {
unsafe {
let text: String = CStr::from_ptr(text_pointer).to_str().expect("Can not read string argument.").to_string();
println!("{}", text);
}
}
和我的 Cargo.toml
:
[package]
name = "mylib"
version = "0.1.0"
authors = ["FrankenApps"]
edition = "2018"
[lib]
crate-type = ["cdylib"]
这是我的 C# 代码:
using System;
using System.Runtime.InteropServices;
namespace dotnet
{
class Program
{
[DllImport("mylib.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern void print_string(string text);
static void Main(string[] args)
{
print_string("Hello World.");
}
}
}
在这种情况下,我运行程序的输出是:
H
当我 运行 链接示例时,出现错误:
thread '<unnamed>' panicked at 'called `Result::unwrap()` on an `Err` value: Utf8Error { valid_up_to: 1, error_len: Some(1) }', src\lib.rs:12:32
然而,当我只使用 ASCII 字符并修改代码时:
生锈:
use libc::c_char;
use std::ffi::CStr;
#[no_mangle]
pub extern "C" fn how_many_characters(s: *const c_char) -> u32 {
let c_str = unsafe {
assert!(!s.is_null());
CStr::from_ptr(s)
};
let r_str = c_str.to_str().unwrap();
println!("{}", r_str.to_string());
r_str.chars().count() as u32
}
C#
using System;
using System.Runtime.InteropServices;
class StringArguments
{
[DllImport("mylib", EntryPoint="how_many_characters")]
public static extern uint HowManyCharacters(string s);
static public void Main()
{
var count = StringArguments.HowManyCharacters("Hello World.");
Console.WriteLine(count);
}
}
我得到了想要的输出:
Hello World.
12
我的问题是我在自己的样本中做错了什么,我试图不使用 libc
? libc 和标准库中的 c_char
之间是否有任何区别,使它们的行为不同?
我猜我漏掉了一些简单的东西,因为我确实希望它能起作用...
您需要使用 CharSet = CharSet.Ansi
,这似乎是默认设置。
当我替换
[DllImport("mylib.dll", CharSet = CharSet.Unicode, SetLastError = true)]
和
[DllImport("mylib.dll", CharSet = CharSet.Ansi, SetLastError = true)]
我确实得到了输出:
Hello World.
如果能以某种方式支持 unicode 字符串,那就太好了。
编辑
我想出了如何使用 UTF-8 字符串。我没有更改 Rust 实现中的任何内容,但不是在 C# 中自动编组 string
,而是在 C# 中使用 UTF-8 编码字节数组作为函数参数:
using System;
using System.Runtime.InteropServices;
namespace dotnet
{
class Program
{
[DllImport("mylib.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern void print_string(byte[] utf8Text);
static void Main(string[] args)
{
print_string(Encoding.UTF8.GetBytes("göes to élevên"));
}
}
}
这完美地工作并打印:
göes to élevên
从 .NET 4.7 开始,您可以使用 MarshalAs(UnmanagedType.LPUTF8Str)
,因此以下内容应该可以正常工作:
using System.Runtime.InteropServices;
namespace dotnet
{
class Program
{
[DllImport("mylib.dll")]
public static extern void print_string([MarshalAs(UnmanagedType.LPUTF8Str)] string utf8Text);
static void Main(string[] args)
{
print_string("göes to élevên");
}
}
}