Enum NodeType

Source

pub enum NodeType {
Show 102 variants    AnonymousClass,
    AnonymousFunction,
    CallArgument,
    Array,
    ArrayItem,
    ArrayLookup,
    ArrowFunction,
    Assignment,
    Attribute,
    AttributeItem,
    Bin,
    Block,
    Boolean,
    Break,
    Call,
    Case,
    Cast,
    Catch,
    Class,
    ClassKeyword,
    Clone,
    CommentBlock,
    CommentDoc,
    CommentLine,
    Const,
    ConstProperty,
    Continue,
    Declare,
    DeclareArgument,
    DoWhile,
    DoWhileCondition,
    Echo,
    Else,
    Elvis,
    Encapsed,
    EncapsedPart,
    Enum,
    EnumItem,
    Eval,
    Exit,
    Finally,
    For,
    Foreach,
    Function,
    Global,
    Goto,
    HereDoc,
    Identifier,
    If,
    Include,
    Inline,
    InstanceOf,
    Interface,
    IntersectionType,
    Label,
    List,
    Magic,
    Match,
    MatchArm,
    Method,
    Namespace,
    Negate,
    New,
    NowDoc,
    Null,
    Number,
    ObjectAccess,
    Parameter,
    Parent,
    Parenthesis,
    Post,
    Pre,
    Print,
    Program,
    Property,
    PropertyItem,
    Reference,
    Return,
    SelfKeyword,
    Silent,
    Static,
    StaticKeyword,
    StaticLookup,
    String,
    Switch,
    Ternary,
    This,
    Trait,
    TraitUse,
    TraitUseAlias,
    TraitUsePrecedence,
    Throw,
    Try,
    Type,
    UnionType,
    Use,
    UseItem,
    Variable,
    Variadic,
    While,
    Yield,
    YieldFrom,
}

Variants§

§

YieldFrom

Trait Implementations§

Source §

impl Clone for NodeType

Source §

fn clone(&self) -> NodeType

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for NodeType

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for NodeType

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl PartialEq for NodeType

Source §

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

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

1.0.0 · Source§

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

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

Source §

impl Serialize for NodeType

Source §

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Source §

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. Read more

Source §

fn ident() -> String

Identifier of this type, excluding generic parameters.

Source §

fn name() -> String

Name of this type in TypeScript, including generic parameters

Source §

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

Source §

fn decl() -> String

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

Source §

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

Source §

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

Source §

fn visit_generics(v: &mut impl TypeVisitor)
where Self: 'static,

Iterates over all type parameters of this type.

Source §

fn output_path() -> Option<&'static Path>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR. Read more

Source §

fn visit_dependencies(v: &mut impl TypeVisitor)
where Self: 'static,

Iterates over all dependency of this type.

Source §

const DOCS: Option<&'static str> = None

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

Source §

fn dependencies() -> Vec<Dependency>
where Self: 'static,

Resolves all dependencies of this type recursively.

Source §

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. Read more

Source §

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. Read more

Source §

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. Read more

Source §

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. Read more

Source §