agave-fs 4.3.0-alpha.2

Agave file system utils
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

use {
    crate::FileSize,
    std::{fs::File, io, path::PathBuf},
};

/// Open `File` coupled with its filesystem location and most useful information
///
/// The attached context for the `File` is kept minimal to make it easy to construct
/// without unnecessary kernel queries, but allowing users to:
/// * associate the file received in callbacks to the request (by its path)
/// * get the file's most useful metadata information
#[derive(Debug)]
pub struct FileInfo {
    pub file: File,
    pub path: PathBuf,
    pub size: FileSize,
}

impl FileInfo {
    /// Create new instance by opening a file from a given `path` and reading its metadata
    pub fn new_from_path(path: impl Into<PathBuf>) -> io::Result<Self> {
        let path = path.into();
        let file = File::open(&path)?;
        Self::new_from_path_and_file(path, file)
    }

    /// Create new instance by using already open `file` and only reading its metadata
    pub fn new_from_path_and_file(path: impl Into<PathBuf>, file: File) -> io::Result<Self> {
        let size = file.metadata()?.len();
        Ok(Self {
            path: path.into(),
            size,
            file,
        })
    }
}