Skip to main content

Workspace

Struct Workspace 

Source
pub struct Workspace {
    pub root: Option<PathBuf>,
    /* private fields */
}
Expand description

The editor workspace — open documents and their IDs.

Fields§

§root: Option<PathBuf>

Root directory for the workspace (e.g. the repo root).

Implementations§

Source§

impl Workspace

Source

pub fn new() -> Self

Creates an empty workspace.

Source

pub fn open(&mut self, doc: Document) -> DocumentId

Opens a document and returns its ID.

Source

pub fn get(&self, id: &DocumentId) -> Option<&Document>

Returns a reference to a document by ID.

Source

pub fn get_mut(&mut self, id: &DocumentId) -> Option<&mut Document>

Returns a mutable reference to a document by ID.

Source

pub fn close(&mut self, id: &DocumentId) -> Option<Document>

Closes a document, returning it if it was open.

Source

pub fn len(&self) -> usize

Returns the number of open documents.

Source

pub fn is_empty(&self) -> bool

Returns true if no documents are open.

Trait Implementations§

Source§

impl Debug for Workspace

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Workspace

Source§

fn default() -> Workspace

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.