EventClient

Struct EventClient 

Source
pub struct EventClient { /* private fields */ }
Expand description

Client to manage the data of a specific event and the reports contained in that event

Can be created by a ProgramClient

let client = Client::with_url("https://your-vtn.com".try_into().unwrap(), None);
let program = client.get_program_by_id(&"program-1".parse().unwrap()).await.unwrap();

// retrieve all events in that specific program
let mut events = program.get_event_list(Filter::none()).await.unwrap();
let mut event = events.remove(0);

// Set event priority to maximum
event.content_mut().priority = Priority::MAX;
event.update().await.unwrap()

Implementations§

Source§

impl EventClient

Source

pub fn id(&self) -> &EventId

Get the id of the event

Source

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

Get the time the event was created on the VTN

Source

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

Get the time the event was last modified on the VTN

Source

pub fn content(&self) -> &EventContent

Read the data of the event

Source

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

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

Source

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

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

Source

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

Delete the event from the VTN

Source

pub fn new_report(&self, client_name: String) -> ReportContent

Create a new report object

Source

pub async fn create_report( &self, report_data: ReportContent, ) -> Result<ReportClient, Error>

Create a new report on the VTN. The content should be created with EventClient::new_report to automatically insert the correct program ID and event ID

Source

pub async fn get_report_list( &self, client_name: Option<&str>, ) -> Result<Vec<ReportClient>, Error>

Get all reports from the VTN, possibly filtered by client_name, trying to paginate whenever possible

Trait Implementations§

Source§

impl Clone for EventClient

Source§

fn clone(&self) -> EventClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EventClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,