Struct SyncRootId

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

The identifier for a sync root.

The inner value comes in the form: provider-id!security-id!account-name as specified here.

A SyncRootId stores an inner, reference counted HSTRING, making this struct cheap to clone.

Implementations

impl SyncRootId

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>

Creates a SyncRootId from the sync root at the given path.

pub fn is_registered(&self) -> Result<bool>

Whether or not the SyncRootId has already been registered.

pub fn info(&self) -> Result<SyncRootInfo>

Returns the sync root information for the SyncRootId.

pub fn register(&self, info: SyncRootInfo) -> Result<()>

Registers the sync root at the current SyncRootId.

SyncRootInfo::display_name, SyncRootInfo::icon, SyncRootInfo::version and SyncRootInfo::path are required and cannot be empty.

pub fn unregister(&self) -> Result<()>

Unregisters the sync root at the current SyncRootId if it exists.

pub fn index(&self) -> Result<()>

Indexes the sync root at the current SyncRootId.

Returns an error if the sync root does not exist or unable to index.

pub fn to_os_string(&self) -> OsString

Encodes the SyncRootId to an OsString.

pub fn as_u16_str(&self) -> &U16Str

A reference to the SyncRootId as a 16 bit string.

pub fn as_hstring(&self) -> &HSTRING

A reference to the SyncRootId as an HSTRING (its inner value).

pub fn to_components(&self) -> (&U16Str, &U16Str, &U16Str)

The three components of a SyncRootId as described by the specification.

The order goes as follows: (provider-id, security-id, account-name)

Panics

Panics if the sync root id does not have exactly three components.

Trait Implementations

impl Clone for SyncRootId

fn clone(&self) -> SyncRootId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncRootId

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

Formats the value using the given formatter.