Struct SchemaConfig 

pub struct SchemaConfig {
    pub custom_fields: HashMap<String, CustomFieldSchema>,
}

Fields

custom_fields: HashMap<String, CustomFieldSchema>

Implementations

impl SchemaConfig

pub fn validate_field( &self, field_name: &str, value: &Value, ) -> Result<(), ValidationError>

pub fn validate_metadata( &self, metadata: &Metadata, ) -> Result<(), ValidationError>

Trait Implementations

impl Clone for SchemaConfig

fn clone(&self) -> SchemaConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaConfig

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

Formats the value using the given formatter.

impl Default for SchemaConfig

fn default() -> SchemaConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SchemaConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SchemaConfig

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 SchemaConfig

const EXPORT_TO: Option<&'static str>

fn decl() -> String

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

fn name() -> String

Name of this type in TypeScript.

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 an type declaration.
This function will panic if the type cannot be flattened.

fn dependencies() -> Vec<Dependency>

where SchemaConfig: 'static,

Information about types this type depends on. This is used for resolving imports when exporting to a file.

fn transparent() -> bool

true if this is a transparent type, e.g tuples or a list.
This is used for resolving imports when using the export! macro.

fn name_with_type_args(args: Vec<String>) -> String

Name of this type in TypeScript, with type arguments.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to a file. The output file can be specified by annotating the type with #[ts(export_to = ".."]. By default, the filename will be derived from the types name.

fn export_to(path: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to a file with a file with the specified path. This function will ignore the #[ts(export_to = "..)] attribute.

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.