pub struct DefinitionFileOptions<'a> {
pub header: Option<&'a str>,
pub root_namespace: Option<&'a str>,
}
Expand description
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
sourceimpl<'a> Clone for DefinitionFileOptions<'a>
impl<'a> Clone for DefinitionFileOptions<'a>
sourcefn clone(&self) -> DefinitionFileOptions<'a>
fn clone(&self) -> DefinitionFileOptions<'a>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'a> Debug for DefinitionFileOptions<'a>
impl<'a> Debug for DefinitionFileOptions<'a>
sourceimpl Default for DefinitionFileOptions<'_>
impl Default for DefinitionFileOptions<'_>
sourceimpl<'a> PartialEq<DefinitionFileOptions<'a>> for DefinitionFileOptions<'a>
impl<'a> PartialEq<DefinitionFileOptions<'a>> for DefinitionFileOptions<'a>
sourcefn eq(&self, other: &DefinitionFileOptions<'a>) -> bool
fn eq(&self, other: &DefinitionFileOptions<'a>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DefinitionFileOptions<'a>) -> bool
fn ne(&self, other: &DefinitionFileOptions<'a>) -> bool
This method tests for !=
.
impl<'a> Copy for DefinitionFileOptions<'a>
impl<'a> Eq for DefinitionFileOptions<'a>
impl<'a> StructuralEq for DefinitionFileOptions<'a>
impl<'a> StructuralPartialEq for DefinitionFileOptions<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for DefinitionFileOptions<'a>
impl<'a> Send for DefinitionFileOptions<'a>
impl<'a> Sync for DefinitionFileOptions<'a>
impl<'a> Unpin for DefinitionFileOptions<'a>
impl<'a> UnwindSafe for DefinitionFileOptions<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more