Skip to main content

Workspace

Struct Workspace 

Source
pub struct Workspace { /* private fields */ }
Expand description

Cloneable handle to the connection’s workspace state (ADR 0017, ADR 0034).

Cheap to clone: every copy shares one Arc, so clones observe the same connection state rather than a snapshot of it. The engine owns construction from InitializeParams; user code only reads it through ServerContext::workspace.

Implementations§

Source§

impl Workspace

Source

pub fn client_info(&self) -> Option<&ClientInfo>

The client info (clientInfo.name / clientInfo.version) announced at initialization, if the client sent any.

Source

pub fn capabilities(&self) -> &ClientCapabilities

The client capabilities announced at initialization, stored verbatim.

Source

pub fn initialization_options(&self) -> Option<&Value>

The client-provided initialization options, exactly as sent.

Source

pub fn root_uri(&self) -> Option<&Uri>

The client’s announced root URI, if any.

Source

pub fn folders(&self) -> Vec<WorkspaceFolder>

The current workspace folders as an owned, order-preserving snapshot.

Source

pub fn configuration(&self) -> Option<Value>

The latest raw workspace/didChangeConfiguration settings value.

The framework neither interprets this value nor persists it outside the connection-owned workspace.

Source

pub fn trace(&self) -> TraceValue

The connection’s current protocol trace level.

Source

pub fn roots(&self) -> Vec<WorkspaceFolder>

The effective workspace roots.

Prefers the announced workspace folders; with none — an absent or empty list — falls back to one synthetic root derived from rootUri, named for its final path segment (percent-decoded, since the name is a display string) or "workspace" when there is none. With no folders and no rootUri, there are no roots.

Source

pub fn documents(&self) -> DocumentsView

The connection’s documents, as a read-only DocumentsView.

The workspace owns the document store the engine mutates through its built-in document-sync handling; user code reads it through this view (or ServerContext::documents, which is the same view).

Source

pub fn notebooks(&self) -> NotebooksView

The connection’s notebooks, as a read-only NotebooksView.

Notebook snapshots contain metadata and ordered cell membership. Read each cell’s text through Workspace::documents using its URI.

Source

pub async fn text_document(&self, uri: &Uri) -> Result<Document, WorkspaceError>

Resolve a document snapshot, preferring editor-open text over the configured provider for unopened resources.

Trait Implementations§

Source§

impl Clone for Workspace

Source§

fn clone(&self) -> Workspace

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Workspace

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> TaskSend for T
where T: Send + ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more