Struct SourceContent 

pub struct SourceContent { /* private fields */ }

Represents key information about a source file and its content:

• The path to the file (or its name, in the case of virtual files)
• The content of the file
• The byte offsets of every line in the file, for use in looking up line/column information

Implementations

impl SourceContent

pub fn new( language: impl AsRef<str>, uri: impl Into<Uri>, content: impl Into<String>, ) -> SourceContent

Create a new SourceContent from the (possibly virtual) file path, and its content as a UTF-8 string.

When created, the line starts for this file will be computed, which requires scanning the file content once.

pub fn language(&self) -> &str

Get the language identifier of this source file

pub fn version(&self) -> i32

Get the current version of this source file’s content

pub fn set_version(&mut self, version: i32)

Set the current version of this content

pub fn uri(&self) -> &Uri

Get the URI of this source file

pub fn as_str(&self) -> &str

Returns the underlying content as a string slice

pub fn as_bytes(&self) -> &[u8]

Returns the underlying content as a byte slice

pub fn len(&self) -> usize

Returns the size in bytes of the underlying content

pub fn is_empty(&self) -> bool

Returns true if the underlying content is empty

pub fn source_range(&self) -> Range<ByteIndex>

Returns the range of valid byte indices for this file

pub fn source_slice(&self, span: impl Into<Range<usize>>) -> Option<&str>

Returns a subset of the underlying content as a string slice.

The bounds of the given span are byte indices, not character indices.

Returns None if the given span is out of bounds, or if the bounds do not fall on valid UTF-8 character boundaries.

pub fn byte_slice(&self, span: impl Into<Range<ByteIndex>>) -> Option<&[u8]>

Returns a subset of the underlying content as a byte slice.

Returns None if the given span is out of bounds

pub fn select(&self, range: Selection) -> Option<&str>

Like Self::source_slice, but the slice is computed like a selection in an editor, i.e. based on line/column positions, rather than raw character indices.

This is useful when mapping LSP operations to content in the source file.

pub fn line_count(&self) -> usize

Returns the number of lines in the source content

pub fn line_start(&self, line_index: LineIndex) -> Option<ByteIndex>

Returns the byte index at which the line corresponding to line_index starts

Returns None if the given index is out of bounds

pub fn last_line_index(&self) -> LineIndex

Returns the index of the last line in this file

pub fn line_range(&self, line_index: LineIndex) -> Option<Range<ByteIndex>>

Get the range of byte indices covered by the given line

pub fn line_index(&self, byte_index: ByteIndex) -> LineIndex

Get the index of the line to which byte_index belongs

pub fn line_column_to_offset( &self, line_index: LineIndex, column_index: ColumnIndex, ) -> Option<ByteIndex>

Get the ByteIndex corresponding to the given line and column indices.

Returns None if the line or column indices are out of bounds.

pub fn location(&self, byte_index: ByteIndex) -> Option<FileLineCol>

Get a FileLineCol corresponding to the line/column in this file at which byte_index occurs

pub fn update( &mut self, text: String, range: Option<Selection>, version: i32, ) -> Result<(), SourceContentUpdateError>

Update the source document after being notified of a change event.

The version indicates the new version of the document

NOTE: This is intended to update a super::SourceManager’s view of the content of the document, not to perform an update against the actual file, wherever it may be.

Trait Implementations

impl Clone for SourceContent

fn clone(&self) -> SourceContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<SourceContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SourceContent

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

where H: Hasher,

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 Ord for SourceContent

fn cmp(&self, other: &SourceContent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SourceContent

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

fn partial_cmp(&self, other: &SourceContent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SourceContent

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SourceContent