Struct CreateVirtualBufferOptions 

pub struct CreateVirtualBufferOptions {
    pub name: String,
    pub mode: Option<String>,
    pub read_only: Option<bool>,
    pub show_line_numbers: Option<bool>,
    pub show_cursors: Option<bool>,
    pub editing_disabled: Option<bool>,
    pub hidden_from_tabs: Option<bool>,
    pub entries: Option<Vec<JsTextPropertyEntry>>,
    pub initial_cursor_line: Option<u32>,
}

Options for createVirtualBuffer

Fields

name: String

Buffer name (displayed in tabs/title)

mode: Option<String>

Mode for keybindings (e.g., “git-log”, “search-results”)

read_only: Option<bool>

Whether buffer is read-only (default: false)

show_line_numbers: Option<bool>

Show line numbers in gutter (default: false)

show_cursors: Option<bool>

Show cursor (default: true)

editing_disabled: Option<bool>

Disable text editing (default: false)

hidden_from_tabs: Option<bool>

Hide from tab bar (default: false)

entries: Option<Vec<JsTextPropertyEntry>>

Initial content entries with optional properties

initial_cursor_line: Option<u32>

Initial cursor line (0-indexed). Applied to the new buffer before it becomes the active buffer, so plugins that want to land the cursor on a specific line don’t have to chase a race against user input between “buffer becomes active” and a follow-up setBufferCursor. Using a line index (rather than a byte offset) keeps the byte-math on the host side where the buffer content is already in UTF-8 bytes, avoiding the UTF-16-vs-UTF-8 mismatch a plugin would otherwise have to navigate.

Trait Implementations

impl Clone for CreateVirtualBufferOptions

fn clone(&self) -> CreateVirtualBufferOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateVirtualBufferOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateVirtualBufferOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateVirtualBufferOptions

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 CreateVirtualBufferOptions

type WithoutGenerics = CreateVirtualBufferOptions

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

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.