Struct riot_sys::vfs_dir_ops

#[repr(C)]
pub struct vfs_dir_ops {
    pub opendir: Option<unsafe extern "C" fn(dirp: *mut vfs_DIR, dirname: *const c_char, abs_path: *const c_char) -> c_int>,
    pub readdir: Option<unsafe extern "C" fn(dirp: *mut vfs_DIR, entry: *mut vfs_dirent_t) -> c_int>,
    pub closedir: Option<unsafe extern "C" fn(dirp: *mut vfs_DIR) -> c_int>,
}

@brief Operations on open directories

Fields

opendir: Option<unsafe extern "C" fn(dirp: *mut vfs_DIR, dirname: *const c_char, abs_path: *const c_char) -> c_int>

@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 @param[in] abs_path null-terminated name of the dir to open, relative to the VFS root (“/”)

@return 0 on success @return <0 on error

readdir: Option<unsafe extern "C" fn(dirp: *mut vfs_DIR, entry: *mut vfs_dirent_t) -> c_int>

@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(dirp: *mut vfs_DIR) -> c_int>

@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

Trait Implementations

impl Clone for vfs_dir_ops

fn clone(&self) -> vfs_dir_ops

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for vfs_dir_ops

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for vfs_dir_ops

fn default() -> vfs_dir_ops

Returns the “default value” for a type.

impl Copy for vfs_dir_ops