Struct GetEventsQuery 

pub struct GetEventsQuery {
    pub time_min: Option<Timestamp>,
    pub time_max: Option<Timestamp>,
    pub created_before: Option<Timestamp>,
    pub created_after: Option<Timestamp>,
    pub invitees_max: Option<PageSize>,
    pub favorites: bool,
    pub invite_status: Vec<EventInviteStatus>,
    pub per_page: Option<PageSize>,
    pub after: Option<Cursor<GetEventsCursorData>>,
    pub adhoc: Option<bool>,
    pub time_independent: Option<bool>,
}

Path query parameters of the GET /events endpoint

Allows for customization in the search for events

Fields

time_min: Option<Timestamp>

Optional minimum time in which the event happens

time_max: Option<Timestamp>

Optional maximum time in which the event happens

created_before: Option<Timestamp>

Only query events created before this timestamp

created_after: Option<Timestamp>

Only query events created after this timestamp

invitees_max: Option<PageSize>

Maximum number of invitees to return inside the event resource

Default value is 0

favorites: bool

Return only favorite events

invite_status: Vec<EventInviteStatus>

Filter the events by invite status

per_page: Option<PageSize>

How many events to return per page

after: Option<Cursor<GetEventsCursorData>>

Cursor token to get the next page of events

Returned by the endpoint if the maximum number of events per page has been hit

adhoc: Option<bool>

Only get events that are either marked as adhoc or non-adhoc

If present, all adhoc events will be returned when true, all non-adhoc events will be returned when false. If not present, all events will be returned regardless of their adhoc flag value.

time_independent: Option<bool>

Only get events that are either time-independent or time-dependent

If present, all time-independent events will be returned when true, all time-dependent events will be returned when false. If absent, all events will be returned regardless of their time dependency.

Trait Implementations

impl Clone for GetEventsQuery

fn clone(&self) -> GetEventsQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetEventsQuery

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

Formats the value using the given formatter.

impl Default for GetEventsQuery

fn default() -> GetEventsQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetEventsQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for GetEventsQuery

fn into_params( parameter_in_provider: impl Fn() -> Option<ParameterIn>, ) -> Vec<Parameter>

Provide Vec of openapi::path::Parameters to caller. The result is used in utoipa-gen library to provide OpenAPI parameter information for the endpoint using the parameters.

impl PartialEq for GetEventsQuery

fn eq(&self, other: &GetEventsQuery) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GetEventsQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GetEventsQuery

impl StructuralPartialEq for GetEventsQuery