Struct epitok::event::Event

pub struct Event {
    pub code: Code,
    pub students: Vec<Student>,
    // some fields omitted
}

Event

Information about an event

Fields

code: Code

Code of event

students: Vec<Student>

Registered students

Implementations

impl Event

pub fn code(&self) -> String

Get URL code

Output format

/module/2019/X-XXX-000/XXX-0-0/acti-000000/event-000000

pub fn intra_page(&self) -> String

Get URL to intra pretty page

Output format

/module/2019/X-XXX-000/XXX-0-0/acti-000000

pub fn title(&self) -> &str

Get name

pub fn module(&self) -> &str

Get module name

pub fn start(&self) -> &str

Get start time in HH:MM format

pub fn end(&self) -> &str

Get finish time in HH:MM format

pub fn students(&mut self) -> &mut Vec<Student>

Get mutable list of students

pub fn set_student_presence(&mut self, login: &str, presence: Presence) -> bool

Set presence type of a student

Arguments

• login - Student email address
• presence - Type of presence to set

pub fn set_student_present(&mut self, login: &str) -> bool

Set student present

Arguments

• login - Student email address

pub fn set_student_missing(&mut self, login: &str) -> bool

Set student missing

Arguments

• login - Student email address

pub fn set_student_none(&mut self, login: &str) -> bool

Remove student presence

Arguments

• login - Student email address

pub fn set_student_not_applicable(&mut self, login: &str) -> bool

Set student N/A

Arguments

• login - Student email address

pub fn set_all_students_present(&mut self)

Set all students as present

pub fn set_all_students_missing(&mut self)

Set all students as missing

pub fn set_all_students_none(&mut self)

Remove presences for all students

pub fn set_all_students_not_applicable(&mut self)

Set presences for all students as Not applicable

pub fn set_remaining_students_present(&mut self)

Set students who do not have a presence status as present

pub fn set_remaining_students_missing(&mut self)

Set students who do not have a presence status as missing

pub async fn fetch_students<'_, '_>(
    &'_ mut self,
    autologin: &'_ str
) -> Result<usize, Box<dyn Error>>

Fetch list of students from an existing event

By default when you fetch an event, its students list is empty. It can be populated using this function.

pub async fn save_changes<'_, '_>(
    &'_ mut self,
    autologin: &'_ str
) -> Result<(), Box<dyn Error>>

Save changes to the intra (upload them)

Arguments

• autologin - Autologin link. If you use the epitok::auth::Auth struct, use its get_autologin method

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.