pub struct Workspace { /* private fields */ }Expand description
A collection of open documents/buffers and their state.
Implementations§
Source§impl Workspace
impl Workspace
Sourcepub fn active_document_id(&self) -> Option<DocumentId>
pub fn active_document_id(&self) -> Option<DocumentId>
Return the active document id (if any).
Sourcepub fn set_active_document(
&mut self,
id: DocumentId,
) -> Result<(), WorkspaceError>
pub fn set_active_document( &mut self, id: DocumentId, ) -> Result<(), WorkspaceError>
Set the active document.
Sourcepub fn open_document(
&mut self,
uri: Option<String>,
text: &str,
viewport_width: usize,
) -> Result<DocumentId, WorkspaceError>
pub fn open_document( &mut self, uri: Option<String>, text: &str, viewport_width: usize, ) -> Result<DocumentId, WorkspaceError>
Open a new document in the workspace.
uriis optional and host-provided (e.g.file:///...).textis the initial contents.
Sourcepub fn close_document(&mut self, id: DocumentId) -> Result<(), WorkspaceError>
pub fn close_document(&mut self, id: DocumentId) -> Result<(), WorkspaceError>
Close a document.
Sourcepub fn document_id_for_uri(&self, uri: &str) -> Option<DocumentId>
pub fn document_id_for_uri(&self, uri: &str) -> Option<DocumentId>
Look up a document by uri.
Sourcepub fn document_metadata(&self, id: DocumentId) -> Option<&DocumentMetadata>
pub fn document_metadata(&self, id: DocumentId) -> Option<&DocumentMetadata>
Get a document’s metadata.
Sourcepub fn set_document_uri(
&mut self,
id: DocumentId,
uri: Option<String>,
) -> Result<(), WorkspaceError>
pub fn set_document_uri( &mut self, id: DocumentId, uri: Option<String>, ) -> Result<(), WorkspaceError>
Update a document’s uri/path.
Sourcepub fn document(&self, id: DocumentId) -> Option<&EditorStateManager>
pub fn document(&self, id: DocumentId) -> Option<&EditorStateManager>
Get an immutable reference to a document state manager.
Sourcepub fn document_mut(
&mut self,
id: DocumentId,
) -> Option<&mut EditorStateManager>
pub fn document_mut( &mut self, id: DocumentId, ) -> Option<&mut EditorStateManager>
Get a mutable reference to a document state manager.
Sourcepub fn active_document(&self) -> Option<&EditorStateManager>
pub fn active_document(&self) -> Option<&EditorStateManager>
Get the active document (if any).
Sourcepub fn active_document_mut(&mut self) -> Option<&mut EditorStateManager>
pub fn active_document_mut(&mut self) -> Option<&mut EditorStateManager>
Get the active document mutably (if any).
Sourcepub fn iter(&self) -> impl Iterator<Item = (DocumentId, &EditorStateManager)>
pub fn iter(&self) -> impl Iterator<Item = (DocumentId, &EditorStateManager)>
Iterate over open documents in DocumentId order.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Workspace
impl !RefUnwindSafe for Workspace
impl Send for Workspace
impl !Sync for Workspace
impl Unpin for Workspace
impl UnsafeUnpin for Workspace
impl !UnwindSafe for Workspace
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more