Enum Request 

pub enum Request {
    Bootstrap,
    ProjectNew(ProjectNewParams),
    ProjectOpen(ProjectPathParams),
    ProjectSave(ProjectSaveParams),
    ProjectInfo,
    SampleLoad(SampleLoadParams),
    Calibrate(CalibrateParams),
    RecommendXo,
    Mimo(MimoParams),
    Results,
    Export(ExportParams),
    JobCancel(JobCancelParams),
    Jobs,
    MeasureMethods,
    MeasureConfigure(MeasureConfigureParams),
    MeasureConfigGet,
    MeasurementRecords,
    MicCalibrationGet,
    MicCalibrationSet(MicCalibrationSetParams),
    MicCalibrationClear,
    MicCalibrationAttach,
    LevelsGet,
    LevelsFillDefaults,
    LevelStop,
    MeasurePosition(MeasurePositionParams),
    PositionClear(PositionClearParams),
    Undo(UndoParams),
    RewLaunch,
    MdatScan(MdatScanParams),
    MdatImport(MdatImportParams),
    ConfigGet,
    ConfigApplyPreset(ConfigPresetParams),
    ConfigSetSubCount(ConfigSubCountParams),
    ConfigSetSpeaker(ConfigSetSpeakerParams),
    ConfigAddSpeaker,
    ConfigRemoveSpeaker(ConfigIndexParams),
    ConfigRenumber,
    ConfigValidate,
    PatchSheetCsv(PathParams),
    DspGet,
    DspSet(DspSetParams),
    LayoutGet,
    LayoutSet(LayoutSetParams),
    PositionEstimate,
    TargetGet,
    TargetSetPoints(TargetPointsParams),
    TargetApplyPreset(TargetPresetParams),
    TargetSave(PathParams),
    TargetLoad(PathParams),
    CalibrationSettingsGet,
    CalibrationSettingsSet(CalibrationSettingsParams),
    CalibrationSettingsEdit(CalibrationSettingsEditParams),
    SubWarnings,
    RewInfo,
    RewDriverSet(RewDriverSetParams),
    ModeSpec(ModeSpecParams),
    AppSettingsGet,
    AppSettingsSet(AppSettingsParams),
    LocalApiStatus,
    LocalApiTokenRegenerate,
    ComputeStatus,
    OpenGpuHelp,
    MeasurementCurves(MeasurementCurvesParams),
    ResultCurves(ResultCurvesParams),
    ResultLines,
    SubTakeValues,
    DialogOpenProject,
    DialogSaveProject(DialogSuggestedParams),
    DialogPickMdat,
    DialogPickFolder(DialogPickFolderParams),
    DialogSaveFile(DialogSaveFileParams),
    DialogOpenFile(DialogOpenFileParams),
    OpenFolder(OpenFolderParams),
    LevelMonitorStart(LevelMonitorStartParams),
    LevelMonitorStop,
    LevelPlay(LevelPlayParams),
    StatusWatchStart,
    StatusWatchStop,
    ExportFolderGet,
    ExportFolderSet(ExportFolderSetParams),
}

A call from the screen.

The method names come from the variant names in one place: serde and strum both rename them to snake_case, and method_names_match_the_wire checks that the two agree.

Variants

Bootstrap

Version, the upstream release this build is ported from, and the platform. The first call the screen makes.

ProjectNew(ProjectNewParams)

The ProjectNew Request variant.

ProjectOpen(ProjectPathParams)

The ProjectOpen Request variant.

ProjectSave(ProjectSaveParams)

The ProjectSave Request variant.

ProjectInfo

The ProjectInfo Request variant.

SampleLoad(SampleLoadParams)

The SampleLoad Request variant.

Calibrate(CalibrateParams)

The Calibrate Request variant.

RecommendXo

The RecommendXo Request variant.

Mimo(MimoParams)

The Mimo Request variant.

Results

The Results Request variant.

Export(ExportParams)

The Export Request variant.

JobCancel(JobCancelParams)

The JobCancel Request variant.

Jobs

The Jobs Request variant.

MeasureMethods

The MeasureMethods Request variant.

MeasureConfigure(MeasureConfigureParams)

The MeasureConfigure Request variant.

MeasureConfigGet

Returns the measurement settings stored in the open project.

MeasurementRecords

Returns one recording-status entry per arranged position.

MicCalibrationGet

Returns the project’s microphone calibration and attachment counts.

MicCalibrationSet(MicCalibrationSetParams)

Reads, validates and stores a microphone calibration file in the project.

MicCalibrationClear

Removes the project’s selected microphone calibration file.

MicCalibrationAttach

Attaches the selected file to sweep measurements that have no mic curve.

LevelsGet

Returns stored per-role level and SPL values.

LevelsFillDefaults

Fills only missing per-role level values with upstream defaults.

LevelStop

Stops the current 2.5-second level burst without stopping its monitor.

MeasurePosition(MeasurePositionParams)

The MeasurePosition Request variant.

PositionClear(PositionClearParams)

The PositionClear Request variant.

Undo(UndoParams)

The Undo Request variant.

RewLaunch

The RewLaunch Request variant.

MdatScan(MdatScanParams)

The MdatScan Request variant.

MdatImport(MdatImportParams)

The MdatImport Request variant.

ConfigGet

Returns the editable speaker configuration.

ConfigApplyPreset(ConfigPresetParams)

Replaces the speaker configuration with a built-in preset.

ConfigSetSubCount(ConfigSubCountParams)

Changes the number of configured subwoofers.

ConfigSetSpeaker(ConfigSetSpeakerParams)

Changes one speaker or one of its bands.

ConfigAddSpeaker

Adds the first unused upstream speaker role.

ConfigRemoveSpeaker(ConfigIndexParams)

Removes one configured speaker.

ConfigRenumber

Renumbers outputs in configuration order.

ConfigValidate

Returns structured configuration validation notices.

PatchSheetCsv(PathParams)

Writes the upstream patch-sheet CSV.

DspGet

Returns the editable DSP profile.

DspSet(DspSetParams)

Applies a DSP preset or manual fields.

LayoutGet

Returns measurement arrangement and timing options.

LayoutSet(LayoutSetParams)

Changes measurement arrangement or timing options.

PositionEstimate

Returns the current per-position and total estimate.

TargetGet

Returns the target curve and presets.

TargetSetPoints(TargetPointsParams)

Replaces target control points.

TargetApplyPreset(TargetPresetParams)

Applies a built-in target preset.

TargetSave(PathParams)

Saves the target curve as upstream JSON.

TargetLoad(PathParams)

Loads the target curve from upstream JSON.

CalibrationSettingsGet

Returns calibration settings stored in the project.

CalibrationSettingsSet(CalibrationSettingsParams)

Stores calibration settings in the project.

CalibrationSettingsEdit(CalibrationSettingsEditParams)

Applies one upstream calibration-screen edit and stores the settings.

SubWarnings

Filter warnings from current settings (gain warnings require a run).

RewInfo

Optional REW facts read through the injected transport.

RewDriverSet(RewDriverSetParams)

Changes REW’s audio driver and returns refreshed REW facts.

ModeSpec(ModeSpecParams)

Returns numeric capabilities for one calibration mode.

AppSettingsGet

Returns application-local settings.

AppSettingsSet(AppSettingsParams)

Stores application-local settings.

LocalApiStatus

Reports the opt-in local API server and token.

LocalApiTokenRegenerate

Replaces the local API bearer token and restarts its server when needed.

ComputeStatus

Available compute devices and the effective application preference.

OpenGpuHelp

Opens the official GPU runtime installation guide for this platform.

MeasurementCurves(MeasurementCurvesParams)

Smoothed, normalized measurement curves and their shared frequency grid.

ResultCurves(ResultCurvesParams)

Ready-to-draw calibration curves and axis limits for one result tab.

ResultLines

Numeric metrics, filter counts, BA rows and coded result notices.

SubTakeValues

Copies the last BA output alignment into the manual sub settings.

DialogOpenProject

Opens a project-file picker through the application host.

DialogSaveProject(DialogSuggestedParams)

Opens a project save-file picker through the application host.

DialogPickMdat

Opens an mdat-file picker through the application host.

DialogPickFolder(DialogPickFolderParams)

Opens a folder picker through the application host.

DialogSaveFile(DialogSaveFileParams)

Opens a typed save-file picker through the application host.

DialogOpenFile(DialogOpenFileParams)

Opens a typed file picker through the application host.

OpenFolder(OpenFolderParams)

Opens a folder in the operating-system file manager.

LevelMonitorStart(LevelMonitorStartParams)

Starts the live input level monitor.

LevelMonitorStop

Stops the live input level monitor.

LevelPlay(LevelPlayParams)

Plays a role’s level-check signal for 2.5 seconds.

StatusWatchStart

Starts watching measurement-method status.

StatusWatchStop

Stops watching measurement-method status.

ExportFolderGet

Returns the stored or derived export base folder.

ExportFolderSet(ExportFolderSetParams)

Stores the export base folder in the open project.

Implementations

impl Request

pub const METHODS: &'static [&'static str] = <Self as strum::VariantNames>::VARIANTS

Every method name, as it appears on the wire, derived from the variants. secs-policy checks that each one is registered in features.toml as ipc.<method>.

pub fn method(&self) -> &'static str

The wire name of this request’s method.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'_derivative_strum> From<&'_derivative_strum Request> for &'static str

fn from(x: &'_derivative_strum Request) -> &'static str

Converts to this type from the input type.

impl From<Request> for &'static str

fn from(x: Request) -> &'static str

Converts to this type from the input type.

impl PartialEq for Request

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Request

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Request

impl TS for Request

type WithoutGenerics = Request

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

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 VariantNames for Request

const VARIANTS: &'static [&'static str]

Names of the variants of this enum