IClass

Struct IClass 

Source
pub struct IClass {
    pub user_session: Option<UserSessionInfo>,
    /* private fields */
}
Expand description

The iClass struct.

Fields§

§user_session: Option<UserSessionInfo>

User session information.

Implementations§

Source§

impl IClass

Source

pub async fn check_in_by_uuid( &self, schedule_uuid: &str, timestamp: u128, ) -> Result<CheckInResult, IClassError>

Checks in the schedule with given uuid. This is equivalent to scanning the QR code on the smart device outside the classroom.

§Errors

See IClassError.

§Panics

This function will panic if system time is before [UNIX_EPOCH].

Source

pub async fn check_in_by_id( &self, schedule_id: &str, timestamp: u128, ) -> Result<CheckInResult, IClassError>

Checks in the schedule with given id. This is equivalent to scanning the QR code on the computer inside the classroom.

§Errors

See IClassError.

§Panics

This function will panic if system time is before [UNIX_EPOCH].

Source§

impl IClass

Source

pub async fn login( &mut self, username: &str, password: &str, ) -> Result<(), IClassError>

Logs in to the iClass platform.

§Errors

See IClassError.

Source

pub fn restore_session_from_file<P: AsRef<Path>>( &mut self, path: P, ) -> Result<(), IoError>

Restores user session from given file.

§Errors

IO errors during file operations.

Source

pub fn save_session_to_file<P: AsRef<Path>>( &self, path: P, ) -> Result<bool, IoError>

Saves user session to given file, if any. Returns whether a session existed.

§Errors

IO errors during file operations.

Source§

impl IClass

Source

pub async fn query_semester(&self) -> Result<Vec<Semester>, IClassError>

Queries current semester.

§Errors

See IClassError.

Source

pub async fn query_courses(&self) -> Result<Vec<Course>, IClassError>

Queries selected courses for current semester.

§Errors

See IClassError.

Source

pub async fn query_daily_schedule( &self, date: &NaiveDate, ) -> Result<Vec<Schedule>, IClassError>

Queries daily schedule.

§Arguments
  • date - A date string in “YYYYMMDD” format within the week to query, like “20251013”.
§Errors

See IClassError.

Source

pub async fn query_weekly_schedule( &self, date: &NaiveDate, ) -> Result<Vec<DailySchedule>, IClassError>

Queries weekly schedule.

§Arguments
  • date - A date string in “YYYYMMDD” format within the week to query, like “20251013”.
§Errors

See IClassError.

Source§

impl IClass

Source

pub fn new() -> Self

Creates a new instance of IClass.

Source

pub fn with_api_root(url: Url) -> Self

Creates a new instance of IClass with given API root URL.

Trait Implementations§

Source§

impl Default for IClass

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for IClass

§

impl !RefUnwindSafe for IClass

§

impl Send for IClass

§

impl Sync for IClass

§

impl Unpin for IClass

§

impl !UnwindSafe for IClass

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more