Struct ts_rs::Dependency

pub struct Dependency {
    pub type_id: TypeId,
    pub ts_name: String,
    pub exported_to: &'static str,
}

A typescript type which is depended upon by other types. This information is required for generating the correct import statements.

Fields

type_id: TypeId

Type ID of the rust type

ts_name: String

Name of the type in TypeScript

exported_to: &'static str

Path to where the type would be exported. By default a filename is derived from the types name, which can be customized with #[ts(export_to = "..")].

Implementations

impl Dependency

pub fn from_ty<T: TS + 'static + ?Sized>() -> Option<Self>

Constructs a Dependency from the given type T. If T is not exportable (meaning T::EXPORT_TO is None), this function will return None

Trait Implementations

impl Debug for Dependency

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

Formats the value using the given formatter.

impl Ord for Dependency

fn cmp(&self, other: &Dependency) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Dependency

fn eq(&self, other: &Dependency) -> 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 PartialOrd for Dependency

fn partial_cmp(&self, other: &Dependency) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Dependency

impl StructuralPartialEq for Dependency