Struct Client 

pub struct Client { /* private fields */ }

A client for interacting with the OpenScheduleAPI.

The Client provides methods to query colleges, campuses, groups, and schedules. It can be configured with a default college for convenience.

Examples

use osars::Client;

let client = Client::new("https://api.example.com")
    .with_college(1);

Implementations

impl Client

pub fn builder(base_url: impl Into<String>) -> ClientBuilder

Create a new builder for constructing a Client.

pub fn new(base_url: &str) -> Self

Creates a new client with the specified base URL.

Arguments

• base_url - The base URL of the API endpoint

Examples

use osars::Client;
let client = Client::new("https://api.example.com");

pub fn base_url(&self) -> &str

Returns the base URL of this client.

pub fn default_college_id(&self) -> Option<u32>

Returns the default college ID if set.

pub fn with_college(self, college_id: u32) -> Self

Sets a default college ID for subsequent queries.

Arguments

• college_id - The ID of the college to set as default

Examples

use osars::Client;
let client = Client::new("https://api.example.com")
    .with_college(1);

pub fn colleges(&self) -> CollegesQuery<'_>

Creates a query to list all colleges.

Examples

use osars::Client;
let client = Client::new("https://api.example.com");
let colleges_query = client.colleges();

pub fn college(&self) -> Result<CollegeQuery<'_>>

Creates a query for the default college.

Errors

Returns Error::Validation if no default college is set.

pub fn campuses(&self) -> Result<CampusesQuery<'_>>

Creates a query to list campuses for the default college.

Errors

Returns Error::Validation if no default college is set.

pub fn campus(&self, campus_id: u32) -> CampusQuery<'_>

Creates a query for a specific campus.

Note: This does not require a default college to be set.

pub fn groups(&self, campus_id: u32) -> GroupsQuery<'_>

Creates a query to list groups for a campus.

Arguments

• campus_id - The ID of the campus

pub fn schedule(&self, group_id: u32) -> ScheduleQuery<'_>

Creates a query for a group’s schedule.

Arguments

• group_id - The ID of the student group

pub fn today(&self, group_id: u32) -> ScheduleQuery<'_>

Creates a query for today’s schedule of a group.

Arguments

• group_id - The ID of the student group

pub fn tomorrow(&self, group_id: u32) -> ScheduleQuery<'_>

Creates a query for tomorrow’s schedule of a group.

Arguments

• group_id - The ID of the student group

pub fn authenticated(self) -> AuthenticatedClient

Create an authenticated client for private endpoints.

pub async fn get_json<T>(&self, path: &str) -> Result<T>

where T: DeserializeOwned,

Perform a GET request and deserialize the JSON response.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.