Struct ProgramClient 

pub struct ProgramClient { /* private fields */ }

A client for interacting with the data in a specific program and the events contained in the program.

Implementations

impl ProgramClient

pub fn id(&self) -> &ProgramId

Get the id of the program

pub fn created_date_time(&self) -> DateTime<Utc>

Get the time the program was created on the VTN

pub fn modification_date_time(&self) -> DateTime<Utc>

Get the time the program was last modified on the VTN

pub fn content(&self) -> &ProgramContent

Read the data of the program

pub fn content_mut(&mut self) -> &mut ProgramContent

Modify the data of the program. Make sure to call update after your modifications to store them on the VTN

pub async fn update(&mut self) -> Result<(), Error>

Stores any modifications made to the program content at the server and refreshes the locally stored data with the returned VTN data

pub async fn delete(self) -> Result<Program, Error>

Delete the program from the VTN

pub async fn create_event( &self, event_data: EventContent, ) -> Result<EventClient, Error>

Create a new event on the VTN. The content should be created with ProgramClient::new_event to automatically insert the correct program ID

pub fn new_event(&self, intervals: Vec<EventInterval>) -> EventContent

Create a new event object within the program

pub async fn get_events_request( &self, filter: Filter<'_, impl AsRef<str>>, pagination: PaginationOptions, ) -> Result<Vec<EventClient>, Error>

Low-level operation that gets a list of events for this program from the VTN with the given query parameters.

To automatically iterate pages, use [self.get_event_list]

pub async fn get_event_list( &self, filter: Filter<'_, impl AsRef<str> + Clone>, ) -> Result<Vec<EventClient>, Error>

Get a list of events from the VTN with the given query parameters

pub async fn get_timeline( &self, filter: Filter<'_, impl AsRef<str> + Clone>, ) -> Result<Timeline, Error>

Retrieves the events for this program from the VTN and tries to build a Timeline from it.

Trait Implementations

impl Clone for ProgramClient

fn clone(&self) -> ProgramClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgramClient

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

Formats the value using the given formatter.