Enum PluginResponse 

pub enum PluginResponse {
    VirtualBufferCreated {
        request_id: u64,
        buffer_id: BufferId,
        split_id: Option<SplitId>,
    },
    TerminalCreated {
        request_id: u64,
        buffer_id: BufferId,
        terminal_id: TerminalId,
        split_id: Option<SplitId>,
    },
    LspRequest {
        request_id: u64,
        result: Result<Value, String>,
    },
    HighlightsComputed {
        request_id: u64,
        spans: Vec<TsHighlightSpan>,
    },
    BufferText {
        request_id: u64,
        text: Result<String, String>,
    },
    LineStartPosition {
        request_id: u64,
        position: Option<usize>,
    },
    LineEndPosition {
        request_id: u64,
        position: Option<usize>,
    },
    BufferLineCount {
        request_id: u64,
        count: Option<usize>,
    },
    CompositeBufferCreated {
        request_id: u64,
        buffer_id: BufferId,
    },
    SplitByLabel {
        request_id: u64,
        split_id: Option<SplitId>,
    },
    WatchPathRegistered {
        request_id: u64,
        result: Result<u64, String>,
    },
}

Response from the editor for async plugin operations

Variants

VirtualBufferCreated

Response to CreateVirtualBufferInSplit with the created buffer ID and split ID

Fields

request_id: u64

buffer_id: BufferId

split_id: Option<SplitId>

TerminalCreated

Response to CreateTerminal with the created buffer, terminal, and split IDs

Fields

request_id: u64

buffer_id: BufferId

terminal_id: TerminalId

split_id: Option<SplitId>

LspRequest

Response to a plugin-initiated LSP request

Fields

request_id: u64

result: Result<Value, String>

HighlightsComputed

Response to RequestHighlights

Fields

request_id: u64

spans: Vec<TsHighlightSpan>

BufferText

Response to GetBufferText with the text content

Fields

request_id: u64

text: Result<String, String>

LineStartPosition

Response to GetLineStartPosition with the byte offset

Fields

request_id: u64

position: Option<usize>

None if line is out of range, Some(offset) for valid line

LineEndPosition

Response to GetLineEndPosition with the byte offset

Fields

request_id: u64

position: Option<usize>

None if line is out of range, Some(offset) for valid line

BufferLineCount

Response to GetBufferLineCount with the total number of lines

Fields

request_id: u64

count: Option<usize>

None if buffer not found, Some(count) for valid buffer

CompositeBufferCreated

Response to CreateCompositeBuffer with the created buffer ID

Fields

request_id: u64

buffer_id: BufferId

SplitByLabel

Response to GetSplitByLabel with the found split ID (if any)

Fields

request_id: u64

split_id: Option<SplitId>

WatchPathRegistered

Response to WatchPath. handle is the editor’s stable id for this watcher, used both as the cancellation token for UnwatchPath and as the routing key in path_changed event payloads. Err indicates the watcher could not be installed (path missing, kernel limit, etc.).

Fields

request_id: u64

result: Result<u64, String>

Implementations

impl PluginResponse

pub fn request_id(&self) -> u64

Trait Implementations

impl Clone for PluginResponse

fn clone(&self) -> PluginResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PluginResponse

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 PluginResponse

type WithoutGenerics = PluginResponse

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

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.