Struct std::fs::File

A file.

Example

use std::fs::{File, Path};
use std::string::StringBuf;

let file = File::open(Path::new("/etc/passwd")).unwrap();
defer file.close();

let buf = StringBuf::new();
defer buf.free();

file.read_to_end(&buf).unwrap();

println!("{}", buf[..]);
Run this example

Fields

• fd: FileDescriptor

Methods

• fn open(path: Path) -> Result<File>

  source

  Opens file in read-only mode.

• fn create(path: Path) -> Result<File>

  source

  Creates a new file for writing (truncating it if it already exists).

• fn open_with(path: Path, opts: &OpenOptions) -> Result<File>

  source

  Opens file with custom options.

• fn attributes(self: &File) -> Result<FileAttr>

  source

  Returns the file attributes (stat) for the file

• fn from_fd(fd: FileDescriptor) -> File

  source

  Create a file object from an existing file descriptor.

• fn as_fd(self: &File) -> FileDescriptor

  source

  Get the file descriptor for the file.

• fn read_to_string(path: Path) -> Result<StringBuf>

  source

  Read the entire file into a StringBuf.

• fn seek(self: &mut File, whence: SeekFrom, offset: i64) -> Result<u64>

  source

  Jump to a specified position in the stream.

  Returns the new position in the stream from the beginning.

• fn flush(self: &mut File) -> Result<()>

  source

  Flush the stream

  This may be a no-op, depending on the stream.

• fn sync(self: &mut File) -> Result<()>

  source

  Flushes disk buffers to disk (fsync)

• fn close(self: &mut File) -> Result<()>

  source

  Closes the file.

• fn move(self: &mut File) -> File

  source

  Creates a copy of the object, leaving an inert object behind.

  See Movable for details.

Mixins

• mixin FdReadWrite<File>

• fn read(self: &mut Self, buf: &mut [u8]) -> Result<usize>

  source

  Reads from the stream into a provided buffer.

  If successful, returns the number of bytes read. This may be less than the size of the provided buffer.

• fn write(self: &mut Self, buf: &[u8]) -> Result<usize>

  source

  Write the buffer to the stream.

  Returns the number of bytes written. This may be less than the size of the buffer. See also write_all, which can be used to write the entire buffer.

• mixin Readable<File>

• fn read_exact(self: &mut Self, buf: &mut [u8]) -> Result<()>

  source

  Fills the provided buffer by reading from the stream.

  If stream had less bytes available than the size of the buffer, this method will return an Error::eof().

• fn read_to_end(self: &mut Self, buf: &mut StringBuf) -> Result<usize>

  source

  Reads the entire stream into a StringBuf.

  If successful, returns the number of bytes that were read.

• mixin Writable<File>

• fn write_all(self: &mut Self, buf: &[u8]) -> Result<()>

  source

  Writes all the bytes in the buffer to the stream.

  If EOF is reached, returns Error::eof().

• mixin Seekable<File>

• fn rewind(self: &mut Self) -> Result<()>

  source

  Rewind the stream to the beginning.

• fn position(self: &mut Self) -> Result<u64>

  source

  Returns the current position in the stream from the beginning.