Struct SyncRootInfo

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

Implementations

impl SyncRootInfo

pub fn allow_pinning(&self) -> bool

Enables or disables the ability for files to be made available offline.

pub fn set_allow_pinning(&mut self, allow_pinning: bool)

Sets the ability for files to be made available offline.

pub fn with_allow_pinning(self, allow_pinning: bool) -> Self

Sets the ability for files to be made available offline.

pub fn allow_hardlinks(&self) -> bool

Hard links are allowed on a placeholder within the same sync root.

pub fn set_allow_hardlinks(&mut self, allow_hardlinks: bool)

Sets the hard link are allowed on a placeholder within the same sync root.

pub fn with_allow_hardlinks(self, allow_hardlinks: bool) -> Self

Sets the hard link are allowed on a placeholder within the same sync root.

pub fn display_name(&self) -> OsString

An optional display name that maps to the existing sync root registration.

pub fn set_display_name(&mut self, display_name: impl AsRef<OsStr>)

Sets the display name that maps to the existing sync root registration.

pub fn with_display_name(self, display_name: impl AsRef<OsStr>) -> Self

Sets the display name that maps to the existing sync root registration.

pub fn recycle_bin_uri(&self) -> Option<OsString>

A Uri to a cloud storage recycle bin.

pub fn set_recycle_bin_uri( &mut self, recycle_bin_uri: impl AsRef<OsStr>, ) -> Result<()>

Sets the Uri to a cloud storage recycle bin.

Returns an error if the Uri is not valid.

pub fn with_recycle_bin_uri( self, recycle_bin_uri: impl AsRef<OsStr>, ) -> Result<Self>

Sets the Uri to a cloud storage recycle bin.

Returns an error if the Uri is not valid.

pub fn show_siblings_as_group(&self) -> bool

Shows sibling sync roots listed under the main sync root in the File Explorer.

pub fn set_show_siblings_as_group(&mut self, show_siblings_as_group: bool)

Shows sibling sync roots listed under the main sync root in the File Explorer or not.

pub fn with_show_siblings_as_group(self, show_siblings_as_group: bool) -> Self

Shows sibling sync roots listed under the main sync root in the File Explorer or not.

pub fn path(&self) -> PathBuf

The path of the sync root.

pub fn set_path(&mut self, path: impl AsRef<Path>) -> Result<()>

Sets the path of the sync root.

Returns an error if the path is not a folder.

pub fn with_path(self, path: impl AsRef<Path>) -> Result<Self>

Sets the path of the sync root.

Returns an error if the path is not a folder.

pub fn population_type(&self) -> PopulationType

The population policy of the sync root registration.

pub fn set_population_type(&mut self, population_type: PopulationType)

Sets the population policy of the sync root registration.

pub fn with_population_type(self, population_type: PopulationType) -> Self

Sets the population policy of the sync root registration.

pub fn version(&self) -> OsString

The version number of the sync root provider.

pub fn set_version(&mut self, version: impl AsRef<OsStr>)

Sets the version number of the sync root provider.

pub fn with_version(self, version: impl AsRef<OsStr>) -> Self

Sets the version number of the sync root provider.

pub fn protection_mode(&self) -> ProtectionMode

The protection mode of the sync root registration.

pub fn set_protection_mode(&mut self, protection_mode: ProtectionMode)

Sets the protection mode of the sync root registration.

pub fn with_protection_mode(self, protection_mode: ProtectionMode) -> Self

Sets the protection mode of the sync root registration.

pub fn supported_attribute(&self) -> FlagSet<SupportedAttribute>

The supported attributes of the sync root registration.

pub fn set_supported_attribute( &mut self, supported_attribute: impl Into<FlagSet<SupportedAttribute>>, )

Sets the supported attributes of the sync root registration.

pub fn with_supported_attribute( self, supported_attribute: impl Into<FlagSet<SupportedAttribute>>, ) -> Self

Sets the supported attributes of the sync root registration.

pub fn hydration_type(&self) -> HydrationType

The hydration policy of the sync root registration.

pub fn set_hydration_type(&mut self, hydration_type: HydrationType)

Sets the hydration policy of the sync root registration.

pub fn with_hydration_type(self, hydration_type: HydrationType) -> Self

Sets the hydration policy of the sync root registration.

pub fn hydration_policy(&self) -> FlagSet<HydrationPolicy>

The hydration policy of the sync root registration.

pub fn set_hydration_policy( &mut self, hydration_policy: impl Into<FlagSet<HydrationPolicy>>, )

Sets the hydration policy of the sync root registration.

pub fn with_hydration_policy( self, hydration_policy: impl Into<FlagSet<HydrationPolicy>>, ) -> Self

Sets the hydration policy of the sync root registration.

pub fn icon(&self) -> OsString

The icon of the sync root registration.

pub fn set_icon(&mut self, icon: impl AsRef<OsStr>)

Sets the icon of the sync root registration.

See also https://docs.microsoft.com/en-us/windows/win32/menurc/icon-resource.

pub fn with_icon(self, icon: impl AsRef<OsStr>) -> Self

Sets the icon of the sync root registration.

See also https://docs.microsoft.com/en-us/windows/win32/menurc/icon-resource.

pub fn id(&self) -> SyncRootId

The identifier of the sync root registration.

pub fn blob(&self) -> Vec<u8>

The blob of the sync root registration.

pub fn set_blob(&mut self, blob: &[u8])

Sets the blob of the sync root registration.

pub fn with_blob(self, blob: &[u8]) -> Self

Sets the blob of the sync root registration.

Trait Implementations

impl Clone for SyncRootInfo

fn clone(&self) -> SyncRootInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncRootInfo

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

Formats the value using the given formatter.

impl Default for SyncRootInfo

fn default() -> Self

Returns the “default value” for a type.