Struct typescript_type_def::DefinitionFileOptions

pub struct DefinitionFileOptions<'a> {
    pub header: Option<&'a str>,
    pub root_namespace: Option<&'a str>,
}

Options for customizing the output of write_definition_file.

The default options are:

DefinitionFileOptions {
    header: Some("// AUTO-GENERATED by typescript-type-def\n"),
    root_namespace: Some("types"),
}

Fields

header: Option<&'a str>

Text to be emitted at the start of the file.

If Some, the string should contain the exact content of the header as TypeScript code (usually in the form of comments). If None, no header will be added.

root_namespace: Option<&'a str>

The name of the root namespace which the definitions will be placed under.

By default, all exported types are wrapped in a root namespace types. This gives all types an unambiguous fully-qualified name. When setting the root_namespace to None, no outer namespace is added. This will work fine in most situations, but it can however lead to errors in the generated TypeScript code when using inner namespaces and types with the same name. If you are using inner namespaces through the #[type_def(namespace = "x.y.z")] attribute, it’s recommended to have a root_namespace as well. See this example of a situation where not having a root namespace can lead to errors.

Trait Implementations

impl<'a> Clone for DefinitionFileOptions<'a>

fn clone(&self) -> DefinitionFileOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DefinitionFileOptions<'a>

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

Formats the value using the given formatter.

impl Default for DefinitionFileOptions<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for DefinitionFileOptions<'a>

fn eq(&self, other: &DefinitionFileOptions<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for DefinitionFileOptions<'a>

impl<'a> Eq for DefinitionFileOptions<'a>

impl<'a> StructuralPartialEq for DefinitionFileOptions<'a>