Struct onedrive_api::option::CollectionOption

pub struct CollectionOption<Field> { /* fields omitted */ }

Option for GET-like requests for a collection of resource objects.

Methods

impl<Field: ResourceField> CollectionOption<Field>

pub fn new() -> Self

Create an empty (default) option.

pub fn if_match(self, tag: &Tag) -> Self

Only response if the object matches the tag.

See also

ObjectOption::if_match

pub fn if_none_match(self, tag: &Tag) -> Self

Only response if the object does not match the tag.

See also

ObjectOption::if_none_match

pub fn select(self, fields: &[Field]) -> Self

Select only some fields of the resource object.

See documentation of module onedrive_api::resource for more details.

See also

ObjectOption::select

pub fn expand(self, field: Field, select_children: Option<&[&str]>) -> Self

Expand a field of the resource object.

See documentation of module onedrive_api::resource for more details.

See also

ObjectOption::expand

pub fn order_by(self, field: Field, order: Order) -> Self

Specify the sort order of the items responsed.

Note

If called more than once, only the last call make sense.

See also

Microsoft Docs

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

Specify the number of items per page.

Note

If called more than once, only the last call make sense.

See also

Microsoft Docs

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

Specify to get the number of all items.

Note

If called more than once, only the last call make sense.

Set it when calling unsupported API will cause HTTP 400 Client Error.

See also

Microsoft Docs

Trait Implementations

impl<Field: ResourceField> Default for CollectionOption<Field>

fn default() -> Self

Returns the "default value" for a type.

impl<Field: Debug> Debug for CollectionOption<Field>

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

Formats the value using the given formatter.