Struct ListFolderArg

#[non_exhaustive]
pub struct ListFolderArg {
    pub path: PathROrId,
    pub recursive: bool,
    pub include_media_info: bool,
    pub include_deleted: bool,
    pub include_has_explicit_shared_members: bool,
    pub include_mounted_folders: bool,
    pub limit: Option<u32>,
    pub shared_link: Option<SharedLink>,
    pub include_property_groups: Option<TemplateFilterBase>,
    pub include_non_downloadable_files: bool,
}

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: PathROrId

A unique identifier for the file.

recursive: bool

If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.

include_media_info: bool

If true, FileMetadata::media_info is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.

include_deleted: bool

If true, the results will include entries for files and folders that used to exist but were deleted.

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_mounted_folders: bool

If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.

limit: Option<u32>

The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.

shared_link: Option<SharedLink>

A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, ListFolderArg::path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.

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_non_downloadable_files: bool

If true, include files that are not downloadable, i.e. Google Docs.

Implementations

impl ListFolderArg

pub fn new(path: PathROrId) -> Self

pub fn with_recursive(self, value: bool) -> 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_mounted_folders(self, value: bool) -> Self

pub fn with_limit(self, value: u32) -> Self

pub fn with_shared_link(self, value: SharedLink) -> Self

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

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

Trait Implementations

impl Clone for ListFolderArg

fn clone(&self) -> ListFolderArg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListFolderArg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ListFolderArg

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

Deserialize this value from the given Serde deserializer.

impl PartialEq for ListFolderArg

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

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

Serialize this value into the given Serde serializer.

impl Eq for ListFolderArg

impl StructuralPartialEq for ListFolderArg