Wrapper FFI seguro

Rust tem Ăłtimo suporte para chamar funçÔes por meio de uma interface para funçÔes externas (Function Foreign Interface - FFI). Usaremos isso para construir um wrapper (invĂłlucro) seguro para as funçÔes da libc de C que vocĂȘ usaria para ler os nomes dos arquivos de um diretĂłrio.

VocĂȘ vai querer consultar as pĂĄginas do manual:

VocĂȘ tambĂ©m vai querer navegar pelo mĂłdulo std::ffi. LĂĄ vocĂȘ encontrarĂĄ um nĂșmero de tipos de string que vocĂȘ precisarĂĄ para o exercĂ­cio:

TiposCodificaçãoUso
str e StringUTF-8Processamento de texto em Rust
CStr e CStringterminado em NULComunicação com funçÔes em C
OsStr e OsStringespecífico ao SOComunicação com o SO

VocĂȘ irĂĄ converter entre todos estes tipos:

  • &str para CString: vocĂȘ precisa alocar espaço para o caracter terminador \0,
  • CString para *const i8: vocĂȘ precisa de um ponteiro para chamar funçÔes em C,
  • *const i8 para &CStr: vocĂȘ vocĂȘ precisa de algo que pode encontrar o caracter terminador \0,
  • &CStr para &[u8]: um slice de bytes Ă© a interface universal para “algum dado desconhecido”,
  • &[u8] para &OsStr: &OsStr Ă© um passo em direção a OsString, use OsStrExt para criĂĄ-lo,
  • &OsStr para OsString: vocĂȘ precisa clonar os dados em &OsStr para poder retornĂĄ-lo e chamar readdir novamente.

O Nomicon tambĂ©m tem um capĂ­tulo bastante Ăștil sobre FFI.

Copie o código abaixo para https://play.rust-lang.org/ e implemente as funçÔes e métodos que faltam:

// TODO: remova isto quando vocĂȘ terminar sua implementação.
#![allow(unused_imports, unused_variables, dead_code)]

mod ffi {
    use std::os::raw::{c_char, c_int};
    #[cfg(not(target_os = "macos"))]
    use std::os::raw::{c_long, c_uchar, c_ulong, c_ushort};

    // Tipo opaco. Veja https://doc.rust-lang.org/nomicon/ffi.html.
    #[repr(C)]
    pub struct DIR {
        _data: [u8; 0],
        _marker: core::marker::PhantomData<(*mut u8, core::marker::PhantomPinned)>,
    }

    // Layout de acordo com a pĂĄgina man do Linux para readdir(3), onde ino_t e
    // off_t são resolvidos de acordo com as definiçÔes em
    // /usr/include/x86_64-linux-gnu/{sys/types.h, bits/typesizes.h}.
    #[cfg(not(target_os = "macos"))]
    #[repr(C)]
    pub struct dirent {
        pub d_ino: c_ulong,
        pub d_off: c_long,
        pub d_reclen: c_ushort,
        pub d_type: c_uchar,
        pub d_name: [c_char; 256],
    }

    // Layout de acordo com a pĂĄgina man do macOS man page para dir(5).
    #[cfg(all(target_os = "macos"))]
    #[repr(C)]
    pub struct dirent {
        pub d_fileno: u64,
        pub d_seekoff: u64,
        pub d_reclen: u16,
        pub d_namlen: u16,
        pub d_type: u8,
        pub d_name: [c_char; 1024],
    }

    extern "C" {
        pub fn opendir(s: *const c_char) -> *mut DIR;

        #[cfg(not(all(target_os = "macos", target_arch = "x86_64")))]
        pub fn readdir(s: *mut DIR) -> *const dirent;

        // Veja https://github.com/rust-lang/libc/issues/414 e a seção sobre
        // _DARWIN_FEATURE_64_BIT_INODE na pĂĄgina man do macOS para stat(2).
        //
        // "Plataformas que existiram antes destas atualizaçÔes estarem disponíveis" refere-se
        // ao macOS (ao contrĂĄrio do iOS / wearOS / etc.) em Intel e PowerPC.
        #[cfg(all(target_os = "macos", target_arch = "x86_64"))]
        #[link_name = "readdir$INODE64"]
        pub fn readdir(s: *mut DIR) -> *const dirent;

        pub fn closedir(s: *mut DIR) -> c_int;
    }
}

use std::ffi::{CStr, CString, OsStr, OsString};
use std::os::unix::ffi::OsStrExt;

#[derive(Debug)]
struct DirectoryIterator {
    path: CString,
    dir: *mut ffi::DIR,
}

impl DirectoryIterator {
    fn new(path: &str) -> Result<DirectoryIterator, String> {
        // Chama opendir e retorna um valor Ok se funcionar,
        // ou retorna Err com uma mensagem.
        unimplemented!()
    }
}

impl Iterator for DirectoryIterator {
    type Item = OsString;
    fn next(&mut self) -> Option<OsString> {
        // Continua chamando readdir até nós obtermos um ponteiro NULL de volta.
        unimplemented!()
    }
}

impl Drop for DirectoryIterator {
    fn drop(&mut self) {
        // Chama closedir se necessĂĄrio.
        unimplemented!()
    }
}

fn main() -> Result<(), String> {
    let iter = DirectoryIterator::new(".")?;
    println!("files: {:#?}", iter.collect::<Vec<_>>());
    Ok(())
}