Struct umm::grade::DocsGrader

pub struct DocsGrader {
    pub project: Project,
    pub files: Array,
    pub out_of: f64,
    pub req_name: String,
    pub penalty: f64,
}

A struct representing arguments to grade_docs function

Fields

project: Project

• project: the project to grade

files: Array

• files: the files to grade

out_of: f64

• out_of: the total points for the requirement

req_name: String

• req_name: the name of the requirement

penalty: f64

• penalty: the penalty to apply for each instance of a violation. Optional, default is 3

Implementations

impl DocsGrader

pub fn project(&mut self) -> Project

Getter for project

pub fn set_project(self, project: Project) -> Self

Setter for project

pub fn files(&mut self) -> Array

Getter for files

pub fn set_files(self, files: Array) -> Self

Setter for files

pub fn out_of(&mut self) -> f64

Getter for out_of

pub fn set_out_of(self, out_of: f64) -> Self

Setter for out_of

pub fn req_name(&mut self) -> String

Getter for req_name

pub fn set_req_name(self, req_name: String) -> Self

Setter for req_name

pub fn penalty(&mut self) -> f64

Getter for penalty

pub fn set_penalty(self, penalty: f64) -> Self

Setter for penalty

pub fn grade_docs(self) -> Result<GradeResult>

Grades documentation by using the -Xdoclint javac flag. Scans javac output for generated warnings and grades accordingly.

pub fn grade_docs_script(self) -> Result<GradeResult, Box<EvalAltResult>>

Macro generated variant of #fn_name that returns EvalAltResult. This allows the function to be used in scripts.

Trait Implementations

impl Clone for DocsGrader

fn clone(&self) -> DocsGrader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CustomType for DocsGrader

Allows registering custom types with Rhai

fn build(builder: TypeBuilder<'_, Self>)

Builds a custom type to be registered with Rhai

impl Default for DocsGrader

fn default() -> DocsGrader

Returns the “default value” for a type.