Module fs

Source
Expand description

Filesystem manipulation operations.

Structs§

AxDirHandle
A handle to an opened directory.
AxDisk
A disk device with a cursor.
AxFileHandle
A handle to an opened file.
AxOpenOptions
Options and flags which can be used to configure how a file is opened.

Enums§

AxSeekFrom
Enumeration of possible methods to seek within an I/O object.

Traits§

MyFileSystemIf
The interface to define custom filesystems in user apps.

Functions§

ax_create_dir
Creates a new, empty directory at the provided path.
ax_current_dir
Returns the current working directory.
ax_file_attr
Returns attributes of the file.
ax_flush_file
Flushes the file, writes all buffered data to the underlying device.
ax_open_dir
Opens a directory at the path relative to the current directory with the options specified by opts.
ax_open_file
Opens a file at the path relative to the current directory with the options specified by opts.
ax_read_dir
Reads directory entries starts from the current position into the given buffer, returns the number of entries read.
ax_read_file
Reads the file at the current position, returns the number of bytes read.
ax_read_file_at
Reads the file at the given position, returns the number of bytes read.
ax_remove_dir
Removes an empty directory.
ax_remove_file
Removes a file from the filesystem.
ax_rename
Rename a file or directory to a new name.
ax_seek_file
Sets the cursor of the file to the specified offset. Returns the new position after the seek.
ax_set_current_dir
Changes the current working directory to the specified path.
ax_truncate_file
Truncates the file to the specified size.
ax_write_file
Writes the file at the current position, returns the number of bytes written.
ax_write_file_at
Writes the file at the given position, returns the number of bytes written.

Type Aliases§

AxDirEntry
Alias of [axfs_vfs::VfsDirEntry].
AxFileAttr
Alias of [axfs_vfs::VfsNodeAttr].
AxFilePerm
Alias of [axfs_vfs::VfsNodePerm].
AxFileType
Alias of [axfs_vfs::VfsNodeType].