pub struct LanguagePackConfig {
pub comment_prefix: Option<String>,
pub block_comment_start: Option<String>,
pub block_comment_end: Option<String>,
pub use_tabs: Option<bool>,
pub tab_size: Option<usize>,
pub auto_indent: Option<bool>,
pub show_whitespace_tabs: Option<bool>,
pub formatter: Option<FormatterPackConfig>,
}Expand description
Language configuration for language packs
This is a simplified version of the full LanguageConfig, containing only the fields that can be set via the plugin API.
Fields§
§comment_prefix: Option<String>Comment prefix for line comments (e.g., “//” or “#”)
block_comment_start: Option<String>Block comment start marker (e.g., slash-star)
block_comment_end: Option<String>Block comment end marker (e.g., star-slash)
use_tabs: Option<bool>Whether to use tabs instead of spaces for indentation
tab_size: Option<usize>Tab size (number of spaces per tab level)
auto_indent: Option<bool>Whether auto-indent is enabled
show_whitespace_tabs: Option<bool>Whether to show whitespace tab indicators (→) for this language Defaults to true. Set to false for languages like Go/Hare that use tabs for indentation.
formatter: Option<FormatterPackConfig>Formatter configuration
Trait Implementations§
Source§impl Clone for LanguagePackConfig
impl Clone for LanguagePackConfig
Source§fn clone(&self) -> LanguagePackConfig
fn clone(&self) -> LanguagePackConfig
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for LanguagePackConfig
impl Debug for LanguagePackConfig
Source§impl Default for LanguagePackConfig
impl Default for LanguagePackConfig
Source§fn default() -> LanguagePackConfig
fn default() -> LanguagePackConfig
Returns the “default value” for a type. Read more
Source§impl<'de> Deserialize<'de> for LanguagePackConfig
impl<'de> Deserialize<'de> for LanguagePackConfig
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl Serialize for LanguagePackConfig
impl Serialize for LanguagePackConfig
Source§impl TS for LanguagePackConfig
impl TS for LanguagePackConfig
Source§type WithoutGenerics = LanguagePackConfig
type WithoutGenerics = LanguagePackConfig
If this type does not have generic parameters, then
The only requirement for these dummy types is that
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. Read moreSource§type OptionInnerType = LanguagePackConfig
type OptionInnerType = LanguagePackConfig
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.Source§fn docs() -> Option<String>
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 = ".."] attributesSource§fn decl_concrete(cfg: &Config) -> String
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().Source§fn decl(cfg: &Config) -> String
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. Read moreSource§fn inline(cfg: &Config) -> String
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.Source§fn inline_flattened(cfg: &Config) -> String
fn inline_flattened(cfg: &Config) -> String
Flatten a type declaration.
This function will panic if the type cannot be flattened.
Source§fn visit_generics(v: &mut impl TypeVisitor)where
Self: 'static,
fn visit_generics(v: &mut impl TypeVisitor)where
Self: 'static,
Iterates over all type parameters of this type.
Source§fn output_path() -> Option<PathBuf>
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. Read moreSource§fn visit_dependencies(v: &mut impl TypeVisitor)where
Self: 'static,
fn visit_dependencies(v: &mut impl TypeVisitor)where
Self: 'static,
Iterates over all dependency of this type.
Source§fn dependencies(cfg: &Config) -> Vec<Dependency>where
Self: 'static,
fn dependencies(cfg: &Config) -> Vec<Dependency>where
Self: 'static,
Resolves all dependencies of this type recursively.
Source§fn export(cfg: &Config) -> Result<(), ExportError>where
Self: 'static,
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. Read moreSource§fn export_all(cfg: &Config) -> Result<(), ExportError>where
Self: 'static,
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. Read moreSource§fn export_to_string(cfg: &Config) -> Result<String, ExportError>where
Self: 'static,
fn export_to_string(cfg: &Config) -> Result<String, ExportError>where
Self: 'static,
Auto Trait Implementations§
impl Freeze for LanguagePackConfig
impl RefUnwindSafe for LanguagePackConfig
impl Send for LanguagePackConfig
impl Sync for LanguagePackConfig
impl Unpin for LanguagePackConfig
impl UnsafeUnpin for LanguagePackConfig
impl UnwindSafe for LanguagePackConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more