Struct IrProfileDto 

pub struct IrProfileDto {
    pub file_name: String,
    pub label: String,
    pub is_custom: bool,
    pub is_in_use: bool,
}

Data transfer object describing a single cabinet impulse-response profile.

Instances are produced by [FileService::get_all_ir_profiles] and returned

Fields

file_name: String

.wav filename as stored on disk (e.g. "vintage-4x12.wav"). This value is what gets stored inside [CabinetDto::ir_file_path] and passed back to the backend when creating or restoring a Cabinet effect. [CabinetDto::ir_file_path]: crate::domain::dto::effect::cabinet_dto::CabinetDto::ir_file_path

label: String

Human-readable display name shown in the frontend dropdown. Derived from file_name by stripping the .wav extension and replacing hyphens and underscores with spaces (e.g. "vintage-4x12.wav" → "vintage 4x12").

is_custom: bool

true when this profile was uploaded by the user and lives in the custom IR directory rather than the bundled resources/default_ir folder. Only custom profiles may be removed; attempting to remove a default profile returns an error from [remove_ir_profile]. [remove_ir_profile]: crate::commands::effect_commands::cabinet_ir::remove_ir_profile

is_in_use: bool

true when at least one Cabinet effect in any active channel currently references this profile by file_name. The frontend uses this to disable the remove-button and prevent deleting an IR that is actively shaping the tone of a running effect chain.

Trait Implementations

impl Clone for IrProfileDto

fn clone(&self) -> IrProfileDto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IrProfileDto

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IrProfileDto

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IrProfileDto

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

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 IrProfileDto

type WithoutGenerics = IrProfileDto

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

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 IrProfileDto