Trait StudentFilePolicy

pub trait StudentFilePolicy {
    // Required methods
    fn new_with_project_config(project_config: TmcProjectYml) -> Self
       where Self: Sized;
    fn get_project_config(&self) -> &TmcProjectYml;
    fn is_non_extra_student_file(&self, file_path: &Path) -> bool;

    // Provided methods
    fn new(project_dir: &Path) -> Result<Self, TmcError>
       where Self: Sized { ... }
    fn is_student_file(&self, file_path: &Path) -> bool { ... }
    fn is_updating_forced(&self, path: &Path) -> Result<bool, TmcError> { ... }
}

Specifies which files are student files. A single StudentFilePolicy is only valid for a single project as it uses a config file to determine its output.

Student files are any files that are expected to be modified and/or created by the student. That is, any files that should not be overwritten when when updating an already downloaded exercise and any files that should be submitted to the server.

Required Methods

fn new_with_project_config(project_config: TmcProjectYml) -> Self

where Self: Sized,

This constructor should store the project config in the implementing struct.

fn get_project_config(&self) -> &TmcProjectYml

The policy should contain a TmcProjectYml parsed from the project this policy was created for.

fn is_non_extra_student_file(&self, file_path: &Path) -> bool

Used by is_student_file. Defines a language plugin policy’s rules for determining whether a file is a student file or not.

Provided Methods

fn new(project_dir: &Path) -> Result<Self, TmcError>

where Self: Sized,

Parses a project config and calls the helper constructor. Implementing types should only be constructed using this function.

fn is_student_file(&self, file_path: &Path) -> bool

Determines whether a file is a student source file.

A file should be considered a student source file if it resides in a location the student is expected to create his or her own source files in the general case. Any special cases are specified as ExtraStudentFiles in a separate configuration.

For example in a Java project that uses Apache Ant, should return true for any files in the src directory.

The file_path should be relative to the project root path.

fn is_updating_forced(&self, path: &Path) -> Result<bool, TmcError>

Used to check for files which should always be overwritten.

The file_path should be relative, starting from the project root.

Implementations on Foreign Types

impl StudentFilePolicy for CSharpStudentFilePolicy

fn new_with_project_config( project_config: TmcProjectYml, ) -> CSharpStudentFilePolicy

where CSharpStudentFilePolicy: Sized,

fn get_project_config(&self) -> &TmcProjectYml

fn is_non_extra_student_file(&self, path: &Path) -> bool

impl StudentFilePolicy for AntStudentFilePolicy

fn new_with_project_config( project_config: TmcProjectYml, ) -> AntStudentFilePolicy

where AntStudentFilePolicy: Sized,

fn get_project_config(&self) -> &TmcProjectYml

fn is_non_extra_student_file(&self, path: &Path) -> bool

impl StudentFilePolicy for MavenStudentFilePolicy

fn new_with_project_config( project_config: TmcProjectYml, ) -> MavenStudentFilePolicy

where MavenStudentFilePolicy: Sized,

fn get_project_config(&self) -> &TmcProjectYml

fn is_non_extra_student_file(&self, path: &Path) -> bool

impl StudentFilePolicy for MakeStudentFilePolicy

fn new_with_project_config( project_config: TmcProjectYml, ) -> MakeStudentFilePolicy

where MakeStudentFilePolicy: Sized,

fn get_project_config(&self) -> &TmcProjectYml

fn is_non_extra_student_file(&self, path: &Path) -> bool

impl StudentFilePolicy for NoTestsStudentFilePolicy

fn new_with_project_config( project_config: TmcProjectYml, ) -> NoTestsStudentFilePolicy

where NoTestsStudentFilePolicy: Sized,

fn get_project_config(&self) -> &TmcProjectYml

fn is_non_extra_student_file(&self, _file_path: &Path) -> bool

impl StudentFilePolicy for Python3StudentFilePolicy

fn new_with_project_config( project_config: TmcProjectYml, ) -> Python3StudentFilePolicy

where Python3StudentFilePolicy: Sized,

fn get_project_config(&self) -> &TmcProjectYml

fn is_non_extra_student_file(&self, path: &Path) -> bool

impl StudentFilePolicy for RStudentFilePolicy

fn new_with_project_config(project_config: TmcProjectYml) -> RStudentFilePolicy

where RStudentFilePolicy: Sized,

fn get_project_config(&self) -> &TmcProjectYml

fn is_non_extra_student_file(&self, path: &Path) -> bool

Implementors

impl StudentFilePolicy for EverythingIsStudentFilePolicy

impl StudentFilePolicy for NothingIsStudentFilePolicy