Struct SourceRange

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

The first two items are the start and end points (byte offsets from the start of the file). The third item is whether the source range belongs to the ‘main’ file, i.e., the file currently being rendered/displayed in the editor.

Implementations

impl SourceRange

pub fn new(start: usize, end: usize, module_id: ModuleId) -> Self

Create a new source range.

pub fn synthetic() -> Self

A source range that doesn’t correspond to any source code.

pub fn is_synthetic(&self) -> bool

True if this is a source range that doesn’t correspond to any source code.

pub fn start(&self) -> usize

Get the start of the range.

pub fn start_as_range(&self) -> Self

Get the start of the range as a zero-length SourceRange, effectively collapse self to it’s start.

pub fn end(&self) -> usize

Get the end of the range.

pub fn module_id(&self) -> ModuleId

Get the module ID of the range.

pub fn is_top_level_module(&self) -> bool

True if this source range is from the top-level module.

pub fn contains(&self, pos: usize) -> bool

Check if the range contains a position.

pub fn start_to_lsp_position(&self, code: &str) -> LspPosition

pub fn end_to_lsp_position(&self, code: &str) -> LspPosition

pub fn to_lsp_range(&self, code: &str) -> LspRange

Trait Implementations

impl Clone for SourceRange

fn clone(&self) -> SourceRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceRange

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

Formats the value using the given formatter.

impl Default for SourceRange

fn default() -> SourceRange

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceRange

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<&Box<Node<T>>> for SourceRange

fn from(v: &Box<Node<T>>) -> Self

Converts to this type from the input type.

impl From<&KclValue> for SourceRange

fn from(item: &KclValue) -> Self

Converts to this type from the input type.

impl From<&SourceRange> for SourceSpan

fn from(source_range: &SourceRange) -> Self

Converts to this type from the input type.

impl From<[usize; 3]> for SourceRange

fn from(value: [usize; 3]) -> Self

Converts to this type from the input type.

impl From<SourceRange> for SourceSpan

fn from(source_range: SourceRange) -> Self

Converts to this type from the input type.

impl<'a> FromKclValue<'a> for SourceRange

fn from_kcl_val(arg: &'a KclValue) -> Option<Self>

Try to convert a KclValue into this type.

impl Hash for SourceRange

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 JsonSchema for SourceRange

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for SourceRange

fn cmp(&self, other: &Self) -> 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 SourceRange

fn eq(&self, other: &SourceRange) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 SourceRange

fn partial_cmp(&self, other: &Self) -> 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 SourceRange

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for SourceRange

type WithoutGenerics = SourceRange

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = SourceRange

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl Copy for SourceRange

impl Eq for SourceRange

impl StructuralPartialEq for SourceRange