Struct lab_grader::criterion::Criterion

pub struct Criterion {
    pub stub: String,
    pub name: String,
    pub worth: i16,
    pub index: i64,
    pub messages: (String, String),
    pub desc: Option<String>,
    pub test: Box<dyn Fn(&TestData) -> bool>,
    pub status: Option<bool>,
    pub hide: bool,
}

A single Criterion

Fields

stub: String

An ID stub used to identify this criterion

name: String

A short (< 30 characters), descriptive name

worth: i16

Point value of this criterion. If it passes, this value will be added to the Submission grade.

Can be negative if you wish to subtract points. Be sure to get your logic right. This value is added to the submission grade if the test returns true.

index: i64

An index to sort by when running.

Lowest first. Defaults to 100.

messages: (String, String)

Pass or fail messages, respectively

When printing a criterion, the appropriate message will be printed. Not much use other than that.

desc: Option<String>

An optional description

test: Box<dyn Fn(&TestData) -> bool>

The criterion's test

Determines if the criterion passes or fails. This signature is required.

status: Option<bool>

If the test passed, failed, or hasn't been run.

None if it hasn't been run, Some(true) or Some(false) otherwise. If this value is Some, the test has been run.

hide: bool

Renders the criterion unable to be printed

Implementations

impl Criterion

pub fn new(name: &str) -> CriterionBuilder

Returns a CriterionBuilder, which can be built().

Example

A basic criterion

use lab_grader::Criterion;

let c = Criterion::new("my crit").build();
assert_eq!(c.name, "my crit");

pub fn success_message(&self) -> &String

Returns the success message, ie. the first message in the messages tuple.

pub fn failure_message(&self) -> &String

Returns the failure message, ie. the second message in the messages tuple.

pub fn attach(&mut self, test: Box<dyn Fn(&TestData) -> bool>)

Sets the test method of a criterion

pub fn test_with_data(&mut self, data: &TestData) -> bool

Runs the criterion's test function with the data provided.

This is almost equivilent to calling (criterion.test)(data), but this method also sets the status of the criterion to the result of the test. You should avoid calling the test directly, and call this or the test method instead.

The criterion must be mutable to call this method, as the status is changed to the result of the test.

You shouldn't call this method directly, instead grade an entire Rubric.

pub fn test(&mut self) -> bool

Runs the criterions test and assigns the result to criterion.status.

This is equivilent to running test_with_data with an empty TestData.

You shouldn't call this method directly, instead grade an entire Rubric.

pub fn print_short(&self)

Prints the essential criterion information in one line.

Names will be padded with spaces on the left to 30 characters wide, so that printing many criteria at once will look better.

pub fn status_message(&self) -> String

Returns the success message if the criterion passed, otherwise returns the failure message

pub fn colored_status_message(&self) -> String

Same as status_message, but the success message will be colored green and the failure message red.

Trait Implementations

impl Display for Criterion

Displays the results of the criterion. You should test the criterion before printing it.

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

Formats the value using the given formatter.