Enum PacketType 

pub enum PacketType {
    RawAudio(AudioFormat),
    OpusAudio,
    Text,
    Transcription,
    Custom {
        type_id: String,
    },
    Binary,
    Any,
    Passthrough,
}

Describes the type of data, used for pre-flight pipeline validation.

Variants

RawAudio(AudioFormat)

Raw, uncompressed audio with a specific format.

OpusAudio

Compressed Opus audio.

Text

Plain text.

Transcription

Structured transcription data with timestamps and metadata.

Custom

Extensible structured packet type (typically produced/consumed by plugins).

type_id should be namespaced and versioned (e.g., plugin::native::vad/vad-event@1).

Fields

type_id: String

Binary

Generic binary data.

Any

A special type for nodes that can accept any format.

Passthrough

A type that passes through the input type unchanged (for type inference).

Used by passthrough nodes like pacer, script, and passthrough, where output type = input type.

Validation Behavior:

• OneShot (static) pipelines: Passthrough types are resolved at compile-time during pipeline compilation. The graph builder traces connections and resolves each Passthrough output to the concrete type of its input. This allows full pre-flight type checking.
• Dynamic pipelines: Passthrough types are validated at runtime during connection. When a connection involves Passthrough, the connection is allowed and the type will be resolved when actual packets flow through the node.

Example: A pacer node with Passthrough output connected to a raw audio input will:

• In oneshot mode: Be resolved to RawAudio during compilation
• In dynamic mode: Accept the connection and adapt at runtime to whatever audio format it receives

Trait Implementations

impl Clone for PacketType

fn clone(&self) -> PacketType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PacketType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PacketType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PacketType

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for PacketType

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

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 PacketType

type WithoutGenerics = PacketType

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

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 PacketType: '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 PacketType: '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 PacketType

impl StructuralPartialEq for PacketType