Struct mediathekviewweb::MediathekQueryBuilder

pub struct MediathekQueryBuilder<'client> { /* private fields */ }

Request builder for the /api/query endpoint.

Implementations

impl MediathekQueryBuilder<'_>

pub fn query( self, fields: impl Into<Vec<QueryField>>, query: impl Into<String> ) -> Self

Add an additional search query.

Multiple queries are combined using a logical AND.

fields describes the fields in which should be searched for query.

pub fn duration_min(self, duration_min: impl Into<Duration>) -> Self

Filter for a minimum duration.

pub fn duration_max(self, duration_max: impl Into<Duration>) -> Self

Filter for a maximum duration.

pub fn include_future(self, include_future: bool) -> Self

Include media with a broadcasting date in the future.

pub fn sort_by(self, sort_by: SortField) -> Self

Sort the results by a specific field.

pub fn sort_order(self, sort_order: SortOrder) -> Self

Set the sort order.

pub fn size(self, size: usize) -> Self

Set the count of results to retrieve.

Can be used for pagination.

pub fn offset(self, offset: usize) -> Self

Skip the specified count of items.

Can be used for pagination.

impl MediathekQueryBuilder<'_>

pub async fn send(self) -> Result<QueryResult>

Build and send the request to the server.

This call can be usually omitted since this type implements IntoFuture.

Trait Implementations

impl<'client> Debug for MediathekQueryBuilder<'client>

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

Formats the value using the given formatter.

impl<'client> IntoFuture for MediathekQueryBuilder<'client>

type Output = Result<QueryResult, Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <MediathekQueryBuilder<'client> as IntoFuture>::Output> + Send + 'client>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl<'client> Serialize for MediathekQueryBuilder<'client>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.