Struct odata_simple_client::ListRequest

pub struct ListRequest { /* fields omitted */ }

Request a list of resources.

Implementations

impl<'a> ListRequest

pub fn new(resource_type: &str) -> Self

pub fn format(self, format: Format) -> Self

Change format of the returned data.

Can be either Format::Json or Format::Xml

pub fn order_by(self, field: &str, direction: Direction) -> Self

Order the returned resources by field, in specified direction. Direction::Ascending by default.

pub fn top(self, count: u32) -> Self

Only retrieve the top count items.

pub fn skip(self, count: u32) -> Self

Skip the first count items.

pub fn inline_count(self, value: InlineCount) -> Self

Include an inline count field in the odata page metadata. Useful for gauging how many results/pages are left. By default this is not specified, which implies InlineCount::None

pub fn filter(self, field: &str, comparison: Comparison, value: &str) -> Self

Filter the returned results using an OData conditional expression.

See the OData 2.0 documentation (section 4.5) for more information.

#[derive(Deserialize, Debug)]
struct Dokument {
    titel: String,
}

let page: Page<Dokument> = datasource
    .fetch_paged(ListRequest::new("Dokument")
        .filter("id", Comparison::Equal, "24")
    ).await.unwrap();
assert_eq!(page.value[0].titel, "Grund- og nærhedsnotat vedr. sanktioner på toldområdet")

pub fn expand<'f, F>(self, field: F) -> Self where
    F: IntoIterator<Item = &'f str>, 

Expand specific relations of the returned object, if possible.

For the Folketinget API for example, you can expand the DokumentAktør field of a Dokument, to simultaneously retrieve information about the document authors, instead of having to do two separate lookups for the DokumentAktør relation and then the actual Aktør.