Struct WorkspaceLease 

pub struct WorkspaceLease {
    pub kind: WorkspaceLeaseKind,
    pub repo: Option<String>,
    pub target: String,
    pub mode: WorkspaceLeaseMode,
}

Declared claim on a file, directory, crate, or IDE object.

Fields

kind: WorkspaceLeaseKind

What kind of target the lease claims.

repo: Option<String>

Owning repo, or None for repo-independent targets such as IDE objects.

target: String

Normalized target path, crate name, or object id.

mode: WorkspaceLeaseMode

Whether the claim is a shared read or an exclusive write.

Implementations

impl WorkspaceLease

pub fn file(repo: impl Into<String>, path: impl Into<String>) -> Self

Builds an exclusive-write lease on a file in a repo.

pub fn directory(repo: impl Into<String>, path: impl Into<String>) -> Self

Builds an exclusive-write lease on a directory subtree in a repo.

pub fn crate_name( repo: impl Into<String>, crate_name: impl Into<String>, ) -> Self

Builds an exclusive-write lease on a named crate in a repo.

pub fn ide_object(object_id: Symbol) -> Self

Builds an exclusive-write lease on an IDE object by id.

pub fn for_read(self) -> Self

Returns the lease downgraded to shared-read mode.

pub fn for_write(self) -> Self

Returns the lease upgraded to exclusive-write mode.

Trait Implementations

impl Clone for WorkspaceLease

fn clone(&self) -> WorkspaceLease

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceLease

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

Formats the value using the given formatter.

impl Eq for WorkspaceLease

impl PartialEq for WorkspaceLease

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