Library guide · API index and notation
This page is generated from the bundled library in this checkout. Signatures and adjacent source comments are reproduced below; the linked guide explains usage, storage, failures, and platform support.
import "std/fs/linux"
This is a provider or implementation package. Start with the linked guide’s application API; native declarations depend on the selected target.
Names used in signatures
Unqualified names denote this package’s types (including other source files in the same package), language built-ins, or generic parameters such as T. Qualified names use the import aliases below. These aliases belong to the library source; import a dependency yourself to use its alias in your program.
| Alias | Package | Source file |
|---|---|---|
error |
std/platform/error |
linux.dodo |
mem |
core/mem |
linux.dodo |
native |
std/platform/native |
linux.dodo |
ptr |
core/ptr |
linux.dodo |
types |
std/fs/types |
linux.dodo |
capabilities
Function · Source
pub fn capabilities() -> types.Capabilities
open_file
Function · Source
pub fn open_file(path: &native.NativeString, read: bool, write: bool, append: bool, truncate: bool, create: bool, exclusive: bool, follow: bool, mode: u32, sharing: u32) -> native.Handle!error.Error
metadata
Function · Source
pub fn metadata(path: &native.NativeString, follow: bool) -> types.Metadata!error.Error
handle_metadata
Function · Source
pub fn handle_metadata(handle: &native.Handle) -> types.Metadata!error.Error
create_directory
Function · Source
pub fn create_directory(path: &native.NativeString, mode: u32) -> void!error.Error
remove_file
Function · Source
pub fn remove_file(path: &native.NativeString) -> void!error.Error
remove_directory
Function · Source
pub fn remove_directory(path: &native.NativeString) -> void!error.Error
rename_path
Function · Source
pub fn rename_path(old: &native.NativeString, new: &native.NativeString, replace: bool) -> void!error.Error
set_mode
Function · Source
pub fn set_mode(path: &native.NativeString, mode: u32) -> void!error.Error
set_readonly
Function · Source
pub fn set_readonly(path: &native.NativeString, readonly: bool) -> void!error.Error
create_symlink
Function · Source
pub fn create_symlink(target: &native.NativeString, path: &native.NativeString, directory: bool) -> void!error.Error
read_symlink
Function · Source
pub fn read_symlink(path: &native.NativeString, bytes: &mut[u8], wide: &mut[u16]) -> native.NativeString!error.Error from(bytes, wide)
canonicalize
Function · Source
pub fn canonicalize(path: &native.NativeString, bytes: &mut[u8], wide: &mut[u16]) -> native.NativeString!error.Error from(bytes, wide)
Directory
Struct · Source
pub struct Directory {
// Private implementation fields omitted.
}
Directory.open
Function · Source
pub fn open(path: &native.NativeString, bytes: &mut[u8], wide: &mut[u16]) -> Directory!error.Error
Directory.close
Function · Source
pub fn close(&mut self) -> void!error.Error
Directory.next
Function · Source
Entries are copied to caller storage; BufferTooSmall preserves the entry for retry. Dot entries are skipped; concurrent changes/order unspecified.
pub fn next(&mut self, bytes: &mut[u8], wide: &mut[u16]) -> Option<native.NativeString>!error.Error from(bytes, wide)