Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Why is it possible to implement Read on an immutable reference to File?

If you check out the docs for Read, most of the methods accept a &mut self. This makes sense, as reading from something usually updates an internal offset so the next read returns different data. However, this compiles:

use std::io::Read;
use std::fs::File;

fn main() {
    let file = File::open("/etc/hosts").unwrap();
    let vec = &mut Vec::new();
    (&file).read_to_end(vec).unwrap();
    println!("{:?}", vec);
}

The file isn't mutable, but the data is certainly being read in. This seems incorrect to me. It was pointed out that there is an impl<'a> Read for &'a File, but the fact that an immutable instance is seemingly being mutated still seems odd.

like image 291
Shepmaster Avatar asked Jul 19 '15 16:07

Shepmaster


1 Answers

As @kennytm pointed out, a.read_to_end(vec) is equivalent to Read::read_to_end(&mut a, vec), so (&file).read_to_end(vec) expands to Read::read_to_end(&mut &file, vec). In the latter expression, &file is a new temporary value of type &File. There is no problem with taking mutable references to an expression (e.g. &mut 42). This is exactly what happens here. The fact that the expression is a reference to an immutable value doesn't matter because we cannot actually mutate the value through a &mut &T.

Regarding the question why we don't need the File to be mutable: File is basically just a newtyped file descriptor, i.e. an index into an open-file table that is managed by the OS. read and friends will not change this descriptor at all, which is why the File does not need to be mutated. There is of course mutation going on, but that is done by the operating system on its own data structures and not in your user-land rust code.

like image 182
fjh Avatar answered Nov 06 '22 10:11

fjh