tristan/rustlings
1
0
Fork 0
mirror of https://github.com/rust-lang/rustlings.git synced 2024-12-27 15:56:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document embedded

Browse source
This commit is contained in:
mo8it 2024-05-13 21:07:04 +02:00
parent 0add5ac240
commit 2dfc7cdb1a
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/embedded.rs
View file

@ -6,6 +6,7 @@ use std::{
use crate::info_file::ExerciseInfo; use crate::info_file::ExerciseInfo;
// Contains all embedded files.
pub static EMBEDDED_FILES: EmbeddedFiles = rustlings_macros::include_files!(); pub static EMBEDDED_FILES: EmbeddedFiles = rustlings_macros::include_files!();
#[derive(Clone, Copy)] #[derive(Clone, Copy)]
@ -31,12 +32,17 @@ impl WriteStrategy {
} }
} }
// Files related to one exercise.
struct ExerciseFiles { struct ExerciseFiles {
// The content of the exercise file.
exercise: &'static [u8], exercise: &'static [u8],
// The content of the solution file.
solution: &'static [u8], solution: &'static [u8],
// Index of the related `ExerciseDir` in `EmbeddedFiles::exercise_dirs`.
dir_ind: usize, dir_ind: usize,
} }
// A directory in the `exercises/` directory.
struct ExerciseDir { struct ExerciseDir {
name: &'static str, name: &'static str,
readme: &'static [u8], readme: &'static [u8],
@ -63,19 +69,20 @@ impl ExerciseDir {
let mut readme_path = dir_path; let mut readme_path = dir_path;
readme_path.push_str("/README.md"); readme_path.push_str("/README.md");
WriteStrategy::Overwrite.write(&readme_path, self.readme)?; WriteStrategy::Overwrite.write(&readme_path, self.readme)
Ok(())
} }
} }
// All embedded files.
pub struct EmbeddedFiles { pub struct EmbeddedFiles {
// `info.toml`
pub info_file: &'static str, pub info_file: &'static str,
exercise_files: &'static [ExerciseFiles], exercise_files: &'static [ExerciseFiles],
exercise_dirs: &'static [ExerciseDir], exercise_dirs: &'static [ExerciseDir],
} }
impl EmbeddedFiles { impl EmbeddedFiles {
// Dump all the embedded files of the `exercises/` direcotry.
pub fn init_exercises_dir(&self, exercise_infos: &[ExerciseInfo]) -> Result<()> { pub fn init_exercises_dir(&self, exercise_infos: &[ExerciseInfo]) -> Result<()> {
create_dir("exercises").context("Failed to create the directory `exercises`")?; create_dir("exercises").context("Failed to create the directory `exercises`")?;