Struct LspUri 

pub struct LspUri(/* private fields */);

LSP-facing URI: a URI as it appears on the wire to or from a language server. This is a newtype around lsp_types::Uri. The type-system point is to force every URI that crosses the editor↔LSP boundary through one of the two checked constructors:

• LspUri::from_host_path — given a host path and the active authority’s host↔remote translation, produces an LspUri that carries the in-container path on container authorities (and the host path everywhere else).
• LspUri::from_wire — wraps a raw lsp_types::Uri that was received from the LSP server. The wrapped URI is “remote-side” under a container authority and must be passed back through LspUri::to_host_path before any filesystem-facing code sees it.

Conversely, the only ways to extract a path are:

• LspUri::to_host_path — applies remote→host translation symmetrically with from_host_path. This is the host-side PathBuf filesystem APIs accept. Untranslated extraction (as_uri().path()) is intentionally not exposed as a method — callers that genuinely want the wire-side path string read as_str() and document why a host-path interpretation isn’t wanted.

Storing buffer URIs in [BufferMetadata] as LspUri (not lsp_types::Uri) keeps the cached form already translated for the active authority, so the dozens of metadata.file_uri() call sites can’t accidentally ship a host URI to a container LSP.

Implementations

impl LspUri

pub fn from_host_path( path: &Path, translation: Option<&PathTranslation>, ) -> Option<Self>

Build an LSP-facing URI from a host path, applying the authority’s host→remote translation when one is set. Returns None for relative paths (matches the pre-newtype helper).

pub fn from_wire(uri: Uri) -> Self

Wrap a raw URI received from the LSP wire. The caller must subsequently translate via Self::to_host_path before opening the file or comparing with host paths — that’s the whole point of having the newtype.

pub fn as_uri(&self) -> &Uri

Borrow the underlying raw URI for serialization to the LSP wire (e.g. into JSON-RPC params). Only the LSP transport layer should call this; editor-level code never sees a bare lsp_types::Uri.

pub fn as_str(&self) -> &str

String form, for log messages and equality comparisons against other URI strings (e.g. when matching a buffer against an incoming notification’s URI). Does not strip the host-vs-container ambiguity — comparisons must be between two LspUris, not between a wire URI and a host URI.

pub fn to_host_path( &self, translation: Option<&PathTranslation>, ) -> Option<PathBuf>

Decode this URI to a host path, applying the authority’s remote→host translation when one is set. Returns None for non-file:// URIs.

pub fn into_inner(self) -> Uri

Consume self and return the raw lsp_types::Uri. Reserved for the wire layer (LSP transport, lsp_types interop). Editor code uses Self::as_uri when it just needs to borrow.

Trait Implementations

impl Clone for LspUri

fn clone(&self) -> LspUri

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LspUri

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

Formats the value using the given formatter.

impl Eq for LspUri

impl Hash for LspUri

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LspUri

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