ax-std 0.5.32

//! Filesystem manipulation operations.

mod dir;
mod file;

#[cfg(feature = "alloc")]
use alloc::{string::String, vec::Vec};

pub use ax_api::fs::{AxFilePermExt as PermissionsExt, AxFileTypeExt as FileTypeExt};

pub use self::{
    dir::{DirBuilder, DirEntry, ReadDir},
    file::{File, FileType, Metadata, OpenOptions, Permissions},
};
use crate::{StdResult, io::prelude::*};

/// Read the entire contents of a file into a bytes vector.
#[cfg(feature = "alloc")]
pub fn read(path: &str) -> StdResult<Vec<u8>> {
    let mut file = File::open(path)?;
    let size = file.metadata().map(|m| m.len()).unwrap_or(0);
    let mut bytes = Vec::with_capacity(size as usize);
    file.read_to_end(&mut bytes)?;
    Ok(bytes)
}

/// Read the entire contents of a file into a string.
#[cfg(feature = "alloc")]
pub fn read_to_string(path: &str) -> StdResult<String> {
    let mut file = File::open(path)?;
    let size = file.metadata().map(|m| m.len()).unwrap_or(0);
    let mut string = String::with_capacity(size as usize);
    file.read_to_string(&mut string)?;
    Ok(string)
}

/// Write a slice as the entire contents of a file.
pub fn write<C: AsRef<[u8]>>(path: &str, contents: C) -> StdResult {
    File::create(path)?.write_all(contents.as_ref())?;
    Ok(())
}

/// Given a path, query the file system to get information about a file,
/// directory, etc.
pub fn metadata(path: &str) -> StdResult<Metadata> {
    File::open(path)?.metadata()
}

/// Returns an iterator over the entries within a directory.
pub fn read_dir(path: &str) -> StdResult<ReadDir<'_>> {
    ReadDir::new(path)
}

/// Creates a new, empty directory at the provided path.
pub fn create_dir(path: &str) -> StdResult {
    DirBuilder::new().create(path)
}

/// Recursively create a directory and all of its parent components if they
/// are missing.
pub fn create_dir_all(path: &str) -> StdResult {
    DirBuilder::new().recursive(true).create(path)
}

/// Removes an empty directory.
pub fn remove_dir(path: &str) -> StdResult {
    ax_api::fs::ax_remove_dir(path)?;
    Ok(())
}

/// Removes a file from the filesystem.
pub fn remove_file(path: &str) -> StdResult {
    ax_api::fs::ax_remove_file(path)?;
    Ok(())
}

/// Rename a file or directory to a new name.
/// Delete the original file if `old` already exists.
///
/// This only works then the new path is in the same mounted fs.
pub fn rename(old: &str, new: &str) -> StdResult {
    ax_api::fs::ax_rename(old, new)?;
    Ok(())
}