Struct cloud_filter::placeholder_file::PlaceholderFile

pub struct PlaceholderFile(/* private fields */);

A builder for creating new placeholder files/directories.

Implementations

impl PlaceholderFile

pub fn new(relative_path: impl AsRef<Path>) -> Self

Creates a new PlaceholderFile.

pub fn has_no_children(self) -> Self

Marks this PlaceholderFile as having no child placeholders on creation.

Only applicable to placeholder directories.

pub fn mark_in_sync(self) -> Self

Marks a placeholder as in sync.

See also SetInSyncState, What does “In-Sync” Mean?

pub fn overwrite(self) -> Self

Whether or not to overwrite an existing placeholder.

pub fn block_dehydration(self) -> Self

Blocks this placeholder file from being dehydrated.

This flag does not work on directories.

pub fn metadata(self, metadata: Metadata) -> Self

The metadata for the PlaceholderFile.

pub fn blob(self, blob: Vec<u8>) -> Self

A buffer of bytes stored with the file that could be accessed through a Request::file_blob or Placeholder::info.

The buffer must not exceed 4KiB.

pub fn result(&self) -> Result<Usn>

pub fn create<P: AsRef<Path>>(self, parent: impl AsRef<Path>) -> Result<Usn>

Creates a placeholder file/directory on the file system.

The value returned is the final Usn after the placeholder is created.

It is recommended to use this function over Placeholder for efficiency purposes. If you need to create multiple placeholders, consider using BatchCreate::create.

If you need to create placeholders from the SyncFilter::fetch_placeholders callback, do not use this method. Instead, use FetchPlaceholders::pass_with_placeholder.

Trait Implementations

impl Debug for PlaceholderFile

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

Formats the value using the given formatter.

impl Drop for PlaceholderFile

fn drop(&mut self)

Executes the destructor for this type.