Type Alias riot_sys::vfs_dir_ops_t

pub type vfs_dir_ops_t = vfs_dir_ops;

@brief Operations on open directories

Aliased Type

struct vfs_dir_ops_t {
    pub opendir: Option<unsafe extern "C" fn(_: *mut vfs_DIR, _: *const u8) -> i32>,
    pub readdir: Option<unsafe extern "C" fn(_: *mut vfs_DIR, _: *mut vfs_dirent_t) -> i32>,
    pub closedir: Option<unsafe extern "C" fn(_: *mut vfs_DIR) -> i32>,
}

Fields

opendir: Option<unsafe extern "C" fn(_: *mut vfs_DIR, _: *const u8) -> i32>

@brief Open a directory for reading with readdir

@param[in] dirp pointer to open directory @param[in] name null-terminated name of the dir to open, relative to the file system root, including a leading slash

@return 0 on success @return <0 on error

readdir: Option<unsafe extern "C" fn(_: *mut vfs_DIR, _: *mut vfs_dirent_t) -> i32>

@brief Read a single entry from the open directory dirp and advance the read position by one

@p entry will be populated with information about the next entry in the directory stream @p dirp

If @p entry was updated successfully, @c readdir shall return 1.

If the end of stream was reached, @c readdir shall return 0 and @p entry shall remain untouched.

@param[in] dirp pointer to open directory @param[out] entry directory entry information

@return 1 if @p entry was updated @return 0 if @p dirp has reached the end of the directory index @return <0 on error

closedir: Option<unsafe extern "C" fn(_: *mut vfs_DIR) -> i32>

@brief Close an open directory

@param[in] dirp pointer to open directory

@return 0 on success @return <0 on error, the directory stream dirp should be considered invalid

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 12 bytes