Struct studentvue::client::Client

pub struct Client<'c> {
    pub uri: Cow<'c, str>,
    pub user: &'c str,
    pub pwd: &'c str,
}

Struct which connects to the StudentVUE service

Fields

uri: Cow<'c, str>

user: &'c str

pwd: &'c str

Methods

impl<'c> Client<'c>

pub fn create(
    district_url: &'c str,
    username: &'c str,
    password: &'c str
) -> Self

Instantiates a new Client with the username, password, and corresponding StudentVUE district url

pub async fn call_service<'_>(
    &'_ self,
    web_service_handle: WebServiceHandle,
    method_name: Method,
    param_str: ParamBuilder
) -> Result<String, VueError>

Calls a method from a specified WebServiceHandle with the specified parameters

Example

use studentvue::{
    client::Client,
    enums::{Method, WebServiceHandle},
    client::ParamBuilder
};
use std::env;

#[tokio::main]
async fn main() {
    let (user, pwd) = (env::args().next().unwrap(), env::args().next().unwrap());

    let client = Client::create("https://studentvue.phoenixunion.org", user.as_str(), pwd.as_str());
    let xml = client.call_service(WebServiceHandle::PXPWebServices, Method::StudentSchoolInfo, ParamBuilder::create())
        .await
        .expect("Could not call service!");

    println!("{}", xml);
}

pub async fn get_grades<'_>(
    &'_ self,
    report_period: Option<u64>
) -> Result<GbData, VueError>

Retrieves grades from a student; can be current or from a specified reporting period

pub async fn get_attendance<'_>(&'_ self) -> Result<AttData, VueError>

Gets the absences from the student

pub async fn get_student_info<'_>(&'_ self) -> Result<Student, VueError>

Retrieves student information such as their name, address, and grade

pub async fn get_schedule<'_>(
    &'_ self
) -> Result<StudentClassSchedule, VueError>

Retrieves the student's current school schedule

pub async fn get_school_info<'_>(
    &'_ self
) -> Result<StudentSchoolInfoListing, VueError>

Grabs information about the currently attended school

Trait Implementations

impl<'c> Clone for Client<'c>

fn clone(&self) -> Client<'c>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for Client<'c>

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

Formats the value using the given formatter.

impl<'c> PartialEq<Client<'c>> for Client<'c>

fn eq(&self, other: &Client<'c>) -> bool

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

fn ne(&self, other: &Client<'c>) -> bool

This method tests for !=.

impl<'c> StructuralPartialEq for Client<'c>