Struct IdConfiguration 

pub struct IdConfiguration {
    pub format: IdFormat,
    pub numbering: NumberingStrategy,
    pub digits: u8,
    pub requirement_types: Vec<RequirementTypeDefinition>,
}

ID system configuration

Fields

format: IdFormat

Format style for IDs

numbering: NumberingStrategy

Numbering strategy

digits: u8

Number of digits for the numeric portion (default 3 = 001)

requirement_types: Vec<RequirementTypeDefinition>

Configured requirement types

Implementations

impl IdConfiguration

pub fn reserved_prefixes(&self) -> Vec<String>

Get all reserved prefixes (type prefixes that cannot be used as feature prefixes)

pub fn is_prefix_reserved(&self, prefix: &str) -> bool

Check if a prefix is reserved (used by a requirement type)

pub fn get_type_by_name(&self, name: &str) -> Option<&RequirementTypeDefinition>

Get a requirement type definition by name

pub fn get_type_by_prefix( &self, prefix: &str, ) -> Option<&RequirementTypeDefinition>

Get a requirement type definition by prefix

pub fn format_number(&self, num: u32) -> String

Format a number with the configured digit width

Trait Implementations

impl Clone for IdConfiguration

fn clone(&self) -> IdConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdConfiguration

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

Formats the value using the given formatter.

impl Default for IdConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IdConfiguration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IdConfiguration

fn eq(&self, other: &IdConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for IdConfiguration

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 IdConfiguration

type WithoutGenerics = IdConfiguration

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

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() -> 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() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> 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() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> 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() -> 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.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> 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() -> 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_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> 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.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl Eq for IdConfiguration

impl StructuralPartialEq for IdConfiguration