ax-api 0.8.0

Public APIs and types for ArceOS modules
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use alloc::string::String;
use ax_fs_ng::fops::{Directory, File};

use crate::ApiResult;

pub use ax_fs_ng::fops::DirEntry as AxDirEntry;
pub use ax_fs_ng::fops::FileAttr as AxFileAttr;
pub use ax_fs_ng::fops::FileAttrExt as AxFileAttrExt;
pub use ax_fs_ng::fops::FilePerm as AxFilePerm;
pub use ax_fs_ng::fops::FilePermExt as AxFilePermExt;
pub use ax_fs_ng::fops::FileType as AxFileType;
pub use ax_fs_ng::fops::FileTypeExt as AxFileTypeExt;
pub use ax_fs_ng::fops::OpenOptions as AxOpenOptions;
pub use ax_io::SeekFrom as AxSeekFrom;

/// A handle to an opened file.
pub struct AxFileHandle(File);

/// A handle to an opened directory.
pub struct AxDirHandle(Directory);

pub fn ax_open_file(path: &str, opts: &AxOpenOptions) -> ApiResult<AxFileHandle> {
    Ok(AxFileHandle(File::open(path, opts)?))
}

pub fn ax_open_dir(path: &str, opts: &AxOpenOptions) -> ApiResult<AxDirHandle> {
    Ok(AxDirHandle(Directory::open_dir(path, opts)?))
}

pub fn ax_read_file(file: &mut AxFileHandle, buf: &mut [u8]) -> ApiResult<usize> {
    Ok(file.0.read(buf)?)
}

pub fn ax_read_file_at(file: &AxFileHandle, offset: u64, buf: &mut [u8]) -> ApiResult<usize> {
    Ok(file.0.read_at(offset, buf)?)
}

pub fn ax_write_file(file: &mut AxFileHandle, buf: &[u8]) -> ApiResult<usize> {
    Ok(file.0.write(buf)?)
}

pub fn ax_write_file_at(file: &AxFileHandle, offset: u64, buf: &[u8]) -> ApiResult<usize> {
    Ok(file.0.write_at(offset, buf)?)
}

pub fn ax_truncate_file(file: &AxFileHandle, size: u64) -> ApiResult {
    file.0.truncate(size)?;
    Ok(())
}

pub fn ax_flush_file(file: &AxFileHandle) -> ApiResult {
    file.0.flush()?;
    Ok(())
}

pub fn ax_seek_file(file: &mut AxFileHandle, pos: AxSeekFrom) -> ApiResult<u64> {
    Ok(file.0.seek(pos)?)
}

pub fn ax_file_attr(file: &AxFileHandle) -> ApiResult<AxFileAttr> {
    Ok(file.0.get_attr()?)
}

pub fn ax_read_dir(dir: &mut AxDirHandle, dirents: &mut [AxDirEntry]) -> ApiResult<usize> {
    Ok(dir.0.read_dir(dirents)?)
}

pub fn ax_create_dir(path: &str) -> ApiResult {
    ax_fs_ng::api::create_dir(path)?;
    Ok(())
}

pub fn ax_remove_dir(path: &str) -> ApiResult {
    ax_fs_ng::api::remove_dir(path)?;
    Ok(())
}

pub fn ax_remove_file(path: &str) -> ApiResult {
    ax_fs_ng::api::remove_file(path)?;
    Ok(())
}

pub fn ax_rename(old: &str, new: &str) -> ApiResult {
    ax_fs_ng::api::rename(old, new)?;
    Ok(())
}

pub fn ax_current_dir() -> ApiResult<String> {
    Ok(ax_fs_ng::api::current_dir()?)
}

pub fn ax_set_current_dir(path: &str) -> ApiResult {
    ax_fs_ng::api::set_current_dir(path)?;
    Ok(())
}