Trait dav_server::ls::DavLockSystem

pub trait DavLockSystem: Debug + Sync + Send + BoxCloneLs {
    fn lock(
        &self,
        path: &DavPath,
        principal: Option<&str>,
        owner: Option<&Element>,
        timeout: Option<Duration>,
        shared: bool,
        deep: bool
    ) -> Result<DavLock, DavLock>;
    fn unlock(&self, path: &DavPath, token: &str) -> Result<(), ()>;
    fn refresh(
        &self,
        path: &DavPath,
        token: &str,
        timeout: Option<Duration>
    ) -> Result<DavLock, ()>;
    fn check(
        &self,
        path: &DavPath,
        principal: Option<&str>,
        ignore_principal: bool,
        deep: bool,
        submitted_tokens: Vec<&str>
    ) -> Result<(), DavLock>;
    fn discover(&self, path: &DavPath) -> Vec<DavLock> ;
    fn delete(&self, path: &DavPath) -> Result<(), ()>;
}

The trait that defines a locksystem.

Required Methods

fn lock(
    &self,
    path: &DavPath,
    principal: Option<&str>,
    owner: Option<&Element>,
    timeout: Option<Duration>,
    shared: bool,
    deep: bool
) -> Result<DavLock, DavLock>

Lock a node. Returns Ok(new_lock) if succeeded, or Err(conflicting_lock) if failed.

fn unlock(&self, path: &DavPath, token: &str) -> Result<(), ()>

Unlock a node. Returns Ok(()) if succeeded, Err (()) if failed (because lock doesn’t exist)

fn refresh(
    &self,
    path: &DavPath,
    token: &str,
    timeout: Option<Duration>
) -> Result<DavLock, ()>

Refresh lock. Returns updated lock if succeeded.

fn check(
    &self,
    path: &DavPath,
    principal: Option<&str>,
    ignore_principal: bool,
    deep: bool,
    submitted_tokens: Vec<&str>
) -> Result<(), DavLock>

Check if node is locked and if so, if we own all the locks. If not, returns as Err one conflicting lock.

fn discover(&self, path: &DavPath) -> Vec<DavLock>

Find and return all locks that cover a given path.

fn delete(&self, path: &DavPath) -> Result<(), ()>

Delete all locks at this path and below (after MOVE or DELETE)

Trait Implementations

impl Clone for Box<dyn DavLockSystem>

fn clone(&self) -> Box<dyn DavLockSystem>

Returns a copy of the value.

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

Performs copy-assignment from source.

Implementors

impl DavLockSystem for FakeLs

impl DavLockSystem for MemLs