Struct FolderMetadata

#[non_exhaustive]
pub struct FolderMetadata {
    pub name: String,
    pub id: Id,
    pub path_lower: Option<String>,
    pub path_display: Option<String>,
    pub parent_shared_folder_id: Option<SharedFolderId>,
    pub preview_url: Option<String>,
    pub shared_folder_id: Option<SharedFolderId>,
    pub sharing_info: Option<FolderSharingInfo>,
    pub property_groups: Option<Vec<PropertyGroup>>,
}

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.

name: String

The last component of the path (including extension). This never contains a slash.

id: Id

A unique identifier for the folder.

path_lower: Option<String>

The lowercased full path in the user’s Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.

path_display: Option<String>

The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user’s filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won’t be returned by list_folder_continue(). This field will be null if the file or folder is not mounted.

parent_shared_folder_id: Option<SharedFolderId>

Please use FileSharingInfo::parent_shared_folder_id or FolderSharingInfo::parent_shared_folder_id instead.

preview_url: Option<String>

The preview URL of the file.

shared_folder_id: Option<SharedFolderId>

Please use sharing_info instead.

sharing_info: Option<FolderSharingInfo>

Set if the folder is contained in a shared folder or is a shared folder mount point.

property_groups: Option<Vec<PropertyGroup>>

Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders.

Implementations

impl FolderMetadata

pub fn new(name: String, id: Id) -> Self

pub fn with_path_lower(self, value: String) -> Self

pub fn with_path_display(self, value: String) -> Self

pub fn with_parent_shared_folder_id(self, value: SharedFolderId) -> Self

pub fn with_preview_url(self, value: String) -> Self

pub fn with_shared_folder_id(self, value: SharedFolderId) -> Self

pub fn with_sharing_info(self, value: FolderSharingInfo) -> Self

pub fn with_property_groups(self, value: Vec<PropertyGroup>) -> Self

Trait Implementations

impl Clone for FolderMetadata

fn clone(&self) -> FolderMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FolderMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FolderMetadata

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

Deserialize this value from the given Serde deserializer.

impl From<FolderMetadata> for Metadata

fn from(subtype: FolderMetadata) -> Self

Converts to this type from the input type.

impl PartialEq for FolderMetadata

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

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

Serialize this value into the given Serde serializer.

impl Eq for FolderMetadata

impl StructuralPartialEq for FolderMetadata