Struct AlphaGetMetadataArg

#[non_exhaustive]
pub struct AlphaGetMetadataArg {
    pub path: ReadPath,
    pub include_media_info: bool,
    pub include_deleted: bool,
    pub include_has_explicit_shared_members: bool,
    pub include_property_groups: Option<TemplateFilterBase>,
    pub include_property_templates: Option<Vec<TemplateId>>,
}

Available on crate features sync_routes and dbx_files only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: ReadPath

The path of a file or folder on Dropbox.

include_media_info: bool

If true, FileMetadata::media_info is set for photo and video.

include_deleted: bool

If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError::NotFound will be returned.

include_has_explicit_shared_members: bool

If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

include_property_groups: Option<TemplateFilterBase>

If set to a valid list of template IDs, FileMetadata::property_groups is set if there exists property data associated with the file and each of the listed templates.

include_property_templates: Option<Vec<TemplateId>>

If set to a valid list of template IDs, FileMetadata::property_groups is set for files with custom properties.

Implementations

impl AlphaGetMetadataArg

pub fn new(path: ReadPath) -> Self

pub fn with_include_media_info(self, value: bool) -> Self

pub fn with_include_deleted(self, value: bool) -> Self

pub fn with_include_has_explicit_shared_members(self, value: bool) -> Self

pub fn with_include_property_groups(self, value: TemplateFilterBase) -> Self

pub fn with_include_property_templates(self, value: Vec<TemplateId>) -> Self

Trait Implementations

impl Clone for AlphaGetMetadataArg

fn clone(&self) -> AlphaGetMetadataArg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlphaGetMetadataArg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AlphaGetMetadataArg

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<AlphaGetMetadataArg> for GetMetadataArg

fn from(subtype: AlphaGetMetadataArg) -> Self

Converts to this type from the input type.

impl PartialEq for AlphaGetMetadataArg

fn eq(&self, other: &AlphaGetMetadataArg) -> 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 AlphaGetMetadataArg

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for AlphaGetMetadataArg

impl StructuralPartialEq for AlphaGetMetadataArg