Struct matchmaker::Student

pub struct Student {
    pub name: String,
    pub preferences: VecDeque<Category>,
    pub exclude: Vec<Category>,
}

Holds a student

Fields

name: String

Name of the student (must be unique)

preferences: VecDeque<Category>

Categories the student wishes to be placed in, in order of preference

exclude: Vec<Category>

Categories the student wishes not to be placed in

Implementations

impl Student

pub fn new(
    name: &str,
    preferences: VecDeque<Category>,
    exclude: Vec<Category>
) -> Self

Return a new Student

Arguments

• name - A &str that holds the name of the student (must be unique)
• preferences - A VecDeque of Categorys the student wishes to be placed in, in order of preference
• exclude - A Vec of Categorys the student wishes not to be placed in

Examples

use std::collections::VecDeque;
use matchmaker::{Category, Student};

// Create categories
let cooking = Category::new("Cooking", 10);
let reading = Category::new("Reading", 10);

// Create student Bert
// Bert wishes to be placed in category cooking or reading (in that order)
let bert = Student::new(
    "Bert",
    VecDeque::from(vec![cooking, reading]),
    Vec::new(),
);

use std::collections::VecDeque;
use matchmaker::{Category, Student};

let cooking = Category::new("Cooking", 10);
let reading = Category::new("Reading", 10);
let walking = Category::new("Walking", 5);

// Create student Suze
// Suze wishes to be placed in category cooking or reading (in that order),
// but does not wish to be placed in category walking
let suze = Student::new(
    "Suze",
    VecDeque::from(vec![cooking, reading]),
    Vec::from([walking]),
);

Trait Implementations

impl Clone for Student

fn clone(&self) -> Student

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Student

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Student

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Student

impl Ord for Student

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Student> for Student

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Student> for Student

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Student

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Student