有没有办法返回在函数中创建的变量的引用？

Question

有没有办法返回在函数中创建的变量的引用？

130

我想编写一个程序，它将以两个步骤编写文件。在运行程序之前，该文件可能不存在。文件名是固定的。

问题在于 OpenOptions.new().write() 可能会失败。在这种情况下，我想调用自定义函数 trycreate()。这个想法是创建文件而不是打开它并返回一个句柄。由于文件名是固定的，trycreate() 没有参数，因此我无法设置返回值的生命周期。

我该如何解决这个问题？

use std::io::Write;
use std::fs::OpenOptions;
use std::path::Path;

fn trycreate() -> &OpenOptions {
    let f = OpenOptions::new().write(true).open("foo.txt");
    let mut f = match f {
        Ok(file)  => file,
        Err(_)  => panic!("ERR"),
    };
    f
}

fn main() {
    {
        let f = OpenOptions::new().write(true).open(b"foo.txt");
        let mut f = match f {
            Ok(file)  => file,
            Err(_)  => trycreate("foo.txt"),
        };
        let buf = b"test1\n";
        let _ret = f.write(buf).unwrap();
    }
    println!("50%");
    {
        let f = OpenOptions::new().append(true).open("foo.txt");
        let mut f = match f {
            Ok(file)  => file,
            Err(_)  => panic!("append"),
        };
        let buf = b"test2\n";
        let _ret = f.write(buf).unwrap();
    }
    println!("Ok");
}

- Nex

打开这个页面，按Ctrl-F，搜索“Cow”，没有结果？？虽然您无法返回在函数中创建的变量的引用，但是您可以使用std::borrow::Cow来泛化拥有的数据和未拥有的引用--它是一个Deref，让您选择给定实例是否拥有或借用其数据。我发现这是在返回拥有和未拥有的数据之间切换的最可靠方法。 - BallpointBen

5个回答

23

有没有办法从没有参数的函数中返回一个引用？

没有（除了对静态值的引用，但这在这里并没有帮助）。

但是，您可能需要查看OpenOptions::create。如果您将main中的第一行更改为：

let  f = OpenOptions::new().write(true).create(true).open(b"foo.txt");

如果文件尚不存在，它将被创建，这应该解决您最初的问题。

- fjh

20

你不能返回指向局部变量的引用。你有两个选择，要么返回值，要么使用静态变量。

原因是：

引用是指向内存位置的指针。一旦函数执行完毕，局部变量就会从执行堆栈中弹出，并且资源也被释放了。在那之后，任何对局部变量的引用都将指向一些无用的数据。由于它已经被释放，它不再属于我们程序的所有权，操作系统可能已经把它分配给另一个进程，我们的数据可能已经被覆盖了。

对于下面这个例子，x 是在函数运行时创建的，并在函数完成执行后被删除。它是局部的，并存在于该特定函数的堆栈上。函数的堆栈保存局部变量。

当 run 从执行堆栈中弹出时，对 x 的任何引用，&x，都将指向一些垃圾数据。这就是人们所说的悬空指针。Rust 编译器不允许使用悬空指针，因为这是不安全的。

fn run() -> &u32 {
    let x: u32 = 42;

    return &x;
} // x is dropped here

fn main() {
    let x = run();
}

因此，我们不能返回对局部变量的引用。我们有两个选择：要么返回该值，要么使用静态变量。

在这里，返回该值是最好的选择。通过返回该值，您将把计算结果传递给调用者，在Rust的术语中，x将由调用者拥有。在我们的例子中，它是main。所以没有问题。

由于静态变量的生存周期与进程运行时间一样长，其引用在函数内外都将指向同一内存位置。在这里也没有问题。

注意：@navigaid建议使用box，但这没有意义，因为您正在将现成的数据移到堆上并返回它。这并没有解决问题，您仍然将局部变量返回给调用方，但在访问时使用了指针。这会由于解引用而增加额外的成本，从而增加不必要的间接性。基本上，您只是为了使用&而使用它，没有其他用途。

- snnsnn

10

像这样在块末尾使用return不是惯用语。 - Shepmaster

3

第一个答案过于冗长，第二个答案又不够详细。因此我们选择使用“返回”来强调重点。 - snnsnn

6

尽管使用了非惯用的 return，但我认为这个答案的解释最清晰易懂。 - jla

这样做更有意义。编译器错误信息可能需要更明显一些。我曾经遇到过这样的情况，我传递了一个拥有的对象，但是只返回对已移动对象的引用，该对象将在函数结束时被丢弃。我更习惯于阅读更常见的"x.foo()在此借用x，但x在函数末尾被丢弃"。 - Josh Bowden

15

这是对snnsnn的回答的详细阐述，该回答简要解释了问题但没有过于具体。

Rust不允许返回在函数中创建的变量的引用。是否有解决方法？是的，只需将该变量放入Box中，然后返回即可。示例：

fn run() -> Box<u32> {
    let x: u32 = 42;
    return Box::new(x);
} 

fn main() {
    println!("{}", run());
}

在 Rust Playground 中的代码

一般来说，在 Rust 中避免类似问题的方法是返回拥有所有权的对象（Box、Vec、String 等），而不是变量的引用：

Box<T> 代替 &T
Vec<T> 代替 &[T]
String 代替 &str

对于其他类型，请参考Rust 类型周期表以确定应使用哪个拥有所有权的对象。

当然，在此示例中，您可以简单地返回值（T 代替 &T 或 Box<T>）

fn run() -> u32 {
    let x: u32 = 42;
    return x;
}

- btwiuse

4

这个答案是错误的且具有误导性。为什么要将一个已经可用的数据进行封装再返回呢？这样只会增加不必要的间接性和成本。 - snnsnn

@snnsnn，u32 变量仅供演示。我已在答案末尾指出。 - btwiuse

2

即使您将适合装箱的变量装箱，该示例仍然是错误的，因为引用是用于将外部作用域中的引用传递到函数中，换句话说，用于借用外部变量，以避免接收和返回的混乱。您的示例完全颠倒了这种逻辑。对于新手来说会很困惑，并且没有真正的用例。 - snnsnn

@snnsnn 如果 Box 的生命周期足够长，通过 Box 在堆上分配值是有意义的。按照 navigaid 的方式，Box 的生命周期太短了，所以就像你说的那样可能没有意义。当作用域结束时，Box 应该被丢弃。因此，我们必须使用 Box::into_raw 或 Box:from_raw。这里也可以看看：https://dev59.com/Pb_qa4cB1Zd3GeqPInyT - lechat