Struct BufferInfo 

pub struct BufferInfo {
    pub id: BufferId,
    pub path: Option<PathBuf>,
    pub modified: bool,
    pub length: usize,
    pub is_virtual: bool,
    pub view_mode: String,
    pub is_composing_in_any_split: bool,
    pub compose_width: Option<u16>,
    pub language: String,
    pub is_preview: bool,
}

Information about a buffer

Fields

id: BufferId

Buffer ID

path: Option<PathBuf>

File path (if any)

modified: bool

Whether the buffer has been modified

length: usize

Length of buffer in bytes

is_virtual: bool

Whether this is a virtual buffer (not backed by a file)

view_mode: String

Current view mode of the active split: “source” or “compose”

is_composing_in_any_split: bool

True if any split showing this buffer has compose mode enabled. Plugins should use this (not view_mode) to decide whether to maintain decorations, since decorations live on the buffer and are filtered per-split at render time.

compose_width: Option<u16>

Compose width (if set), from the active split’s view state

language: String

The detected language for this buffer (e.g., “rust”, “markdown”, “text”)

is_preview: bool

Whether this tab was opened in “preview” (ephemeral) mode — true when opened via single-click in the file explorer and not yet committed (no edit, no double-click, no tab-click, no layout change). Plugins that react to buffer lifecycle events should generally treat preview buffers as transient; e.g. a diagnostics panel may want to skip refreshing itself for a preview tab.

Trait Implementations

impl Clone for BufferInfo

fn clone(&self) -> BufferInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BufferInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BufferInfo

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 TS for BufferInfo

type WithoutGenerics = BufferInfo

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

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 BufferInfo: '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 BufferInfo: '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.