Struct UploadArg

#[non_exhaustive]
pub struct UploadArg {
    pub path: WritePathOrId,
    pub mode: WriteMode,
    pub autorename: bool,
    pub client_modified: Option<DropboxTimestamp>,
    pub mute: bool,
    pub property_groups: Option<Vec<PropertyGroup>>,
    pub strict_conflict: bool,
    pub content_hash: Option<Sha256HexHash>,
}

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

Path in the user’s Dropbox to save the file.

mode: WriteMode

Selects what to do if the file already exists.

autorename: bool

If there’s a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.

client_modified: Option<DropboxTimestamp>

The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.

mute: bool

Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn’t result in a user notification.

property_groups: Option<Vec<PropertyGroup>>

List of custom properties to add to file.

strict_conflict: bool

Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode::Update and the given “rev” doesn’t match the existing file’s “rev”, even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.

content_hash: Option<Sha256HexHash>

A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.

Implementations

impl UploadArg

pub fn new(path: WritePathOrId) -> Self

pub fn with_mode(self, value: WriteMode) -> Self

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

pub fn with_client_modified(self, value: DropboxTimestamp) -> Self

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

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

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

pub fn with_content_hash(self, value: Sha256HexHash) -> Self

Trait Implementations

impl Clone for UploadArg

fn clone(&self) -> UploadArg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UploadArg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UploadArg

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

Deserialize this value from the given Serde deserializer.

impl From<UploadArg> for CommitInfo

fn from(subtype: UploadArg) -> Self

Converts to this type from the input type.

impl PartialEq for UploadArg

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

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

Serialize this value into the given Serde serializer.

impl Eq for UploadArg

impl StructuralPartialEq for UploadArg