Struct TsCompletionContext 

pub struct TsCompletionContext {
    pub prefix: String,
    pub cursor_byte: usize,
    pub word_start_byte: usize,
    pub buffer_len: usize,
    pub is_large_file: bool,
    pub text_around_cursor: String,
    pub cursor_offset_in_text: usize,
    pub language_id: Option<String>,
}

Context sent to a TypeScript plugin’s provideCompletions handler.

Plugins receive this as a read-only snapshot so they never need direct buffer access (which would be unsafe for huge files).

Fields

prefix: String

The word prefix typed so far.

cursor_byte: usize

Byte offset of the cursor.

word_start_byte: usize

Byte offset of the word start (for replacement range).

buffer_len: usize

Total buffer size in bytes.

is_large_file: bool

Whether the buffer is a lazily-loaded huge file.

text_around_cursor: String

A text excerpt around the cursor (the contents of the safe scan window). Plugins should search only this string, not request the full buffer.

cursor_offset_in_text: usize

Byte offset within text_around_cursor that corresponds to the cursor.

language_id: Option<String>

File language id (e.g. "rust", "typescript"), if known.

Trait Implementations

impl Clone for TsCompletionContext

fn clone(&self) -> TsCompletionContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TsCompletionContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TsCompletionContext

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TsCompletionContext

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 TsCompletionContext

type WithoutGenerics = TsCompletionContext

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 = TsCompletionContext

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(cfg: &Config) -> 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(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> 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(cfg: &Config) -> String

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

fn inline(cfg: &Config) -> 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(cfg: &Config) -> 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, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> 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(cfg: &Config) -> 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_to_string(cfg: &Config) -> 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.