Struct ScDistortionDto 

pub struct ScDistortionDto {
    pub id: u32,
    pub name: String,
    pub is_active: bool,
    pub color: String,
    pub threshold: f32,
    pub level: f32,
    pub smoothing: f32,
}

Data Transfer Object for SC Distortion Effect

ScDistortionDto is the serialisable representation of an SCDistortion effect for communication between the Rust backend and the TypeScript frontend.

This DTO is automatically generated for TypeScript via the ts-rs crate

Fields

id: u32

Unique identifier for this effect instance. Used for targeting commands.

name: String

Human-readable name displayed in the UI pedal. Example: "Distortion".

is_active: bool

Whether the effect is currently active/processing audio (true) or bypassed (false). When false, the input signal passes through unchanged.

color: String

UI colour for the pedal chassis. Hex string format: "#rrggbb".

threshold: f32

clipping threshold in the range [0.0, 1.0].

level: f32

Normalised output level boost in [0.0, 1.0].

• 0.0 = unity gain (no boost)
• 1.0 = ×2.0 boost

smoothing: f32

The smoothing factor that determines how much the curve is curved towards the clipping threshold [1.0,10.0].

Trait Implementations

impl Clone for ScDistortionDto

fn clone(&self) -> ScDistortionDto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScDistortionDto

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScDistortionDto

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScDistortionDto

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

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 ScDistortionDto

type WithoutGenerics = ScDistortionDto

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

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(cfg: &Config) -> 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(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> 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(cfg: &Config) -> String

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

fn inline(cfg: &Config) -> 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(cfg: &Config) -> 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, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> 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(cfg: &Config) -> 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_to_string(cfg: &Config) -> 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.

impl StructuralPartialEq for ScDistortionDto