Struct ObjectOption

pub struct ObjectOption<Field> { /* private fields */ }

Option for GET-like requests to one resource object.

Implementations

impl<Field: ResourceField> ObjectOption<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.

Will cause HTTP 412 Precondition Failed otherwise.

It is usually used for PUT-like requests to assert preconditions, but most of GET-like requests also support it.

It will add If-Match to the request header.

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

Only response if the object does not match the tag.

Will cause the relative API returns None otherwise.

It is usually used for GET-like requests to reduce data transmission if cached data can be reused.

This will add If-None-Match to the request header.

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.

Note

If called more than once, all fields mentioned will be selected.

See also

Microsoft Docs

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.

Note

If called more than once, all fields mentioned will be expanded. select_children should be raw camelCase field names mentioned in Microsoft Docs below.

See also

Microsoft Docs

Trait Implementations

impl<Field: Clone> Clone for ObjectOption<Field>

fn clone(&self) -> ObjectOption<Field>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Field: Debug> Debug for ObjectOption<Field>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<Field: PartialEq> PartialEq for ObjectOption<Field>

fn eq(&self, other: &ObjectOption<Field>) -> 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<Field: Eq> Eq for ObjectOption<Field>

impl<Field> StructuralPartialEq for ObjectOption<Field>