[][src]Struct kni_rs::Portal

pub struct Portal { /* fields omitted */ }

Struct used to access the Kamar API.

Implementations

impl Portal[src]

pub fn new(url: &str) -> Self[src]

Creates a new Portal struct with the given url and the key vtku

Params

  • url: The full url of the portal api, i.e. https://demo.school.kiwi/api/api.php

pub fn with_key(url: &str, key: &str) -> Self[src]

Creates a new Portal struct with the given url and key

Params

  • url: The full url of the portal api, i.e. https://demo.school.kiwi/api/api.php
  • key: The authentication key from the API, if the default does not work

pub async fn get_notices_today(&self) -> Result<NoticesResults, NoticesError>[src]

Gets the notices for today from the specified portal

pub async fn get_notices(
    &self,
    date: &DateTime<Utc>
) -> Result<NoticesResults, NoticesError>
[src]

Gets the notices for the specified date from the specified portal

Params

  • date: The date that you would like to get the notices for

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.