Files
oak-editor/crates/oak-audio/src/error.rs
T
Mike-Solar 244d5e860f
CI / Build & test (Windows) (push) Failing after 7s
workspace: kebab-case crates, app under crates/oak-app, shared versions
All crates take the oak-* kebab-case naming (oak-audio, oak-codec,
oak-common, oak-core, oak-ffmpeg-link, oak-node, oak-otio, oak-plugin,
oak-render, oak-storage, oak-task, oak-timeline, oak-undo), with the
lib identifiers rewritten (oakrender:: -> oak_render::, oakcore_rs:: ->
oak_core::, ...) across all 226 referencing files.

The GUI application moves from the workspace root into
crates/oak-app/: src/, build.rs (paths fixed for the new location) and
tests/ travel with it, the root Cargo.toml becomes workspace-only
([workspace] + workspace.package + profiles), and the app package
inherits the workspace version. The screenshots example becomes a
standalone crate examples/simple_player/ with its own Cargo.toml.

Every crate now inherits the single workspace version
(version.workspace = true), and the workflows' crate paths and the
build docs follow the renames.

Validated with a clean cargo check --workspace.
2026-08-22 16:58:37 +08:00

124 lines
3.7 KiB
Rust

// Oak Video Editor - Non-Linear Video Editor
// Copyright (C) 2026 Oak Team
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//! Error codes, mirroring `include/audio/error.h` verbatim; project-wide
//! -MMCCCC scheme (module registry in include/common/error.h), pass-through
//! untranslated. Audio module number is 06, so codes are -60001..-60005.
//! Unlike codec/task there is no CANCELLED code.
/// Success.
pub const OAKAUDIO_OK: i32 = 0;
/// Null handle or invalid argument.
pub const OAKAUDIO_E_INVALID: i32 = -60001;
/// Call not valid in the current state.
pub const OAKAUDIO_E_STATE: i32 = -60002;
/// The underlying operation failed.
pub const OAKAUDIO_E_FAILED: i32 = -60003;
/// Index out of range / entry not found.
pub const OAKAUDIO_E_NOT_FOUND: i32 = -60004;
/// Allocation failed.
pub const OAKAUDIO_E_NOMEM: i32 = -60005;
/// Crate-internal result type; the FFI layer maps it to the codes.
pub type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;
/// Crate-internal error.
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// Null handle or invalid argument.
#[error("audio: invalid argument")]
Invalid,
/// Wrong state.
#[error("audio: invalid state")]
State,
/// Operation failed (context string is log-only).
#[error("audio: operation failed: {0}")]
Failed(String),
/// Not found.
#[error("audio: not found")]
NotFound,
/// Out of memory.
#[error("audio: out of memory")]
NoMem,
}
impl Error {
/// Map to the public error code.
pub fn code(&self) -> i32 {
match self {
Error::Invalid => OAKAUDIO_E_INVALID,
Error::State => OAKAUDIO_E_STATE,
Error::Failed(_) => OAKAUDIO_E_FAILED,
Error::NotFound => OAKAUDIO_E_NOT_FOUND,
Error::NoMem => OAKAUDIO_E_NOMEM,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
/// Every variant must produce a non-empty `Display` message; the
/// `Failed` variant must surface its context string.
#[test]
fn display_is_non_empty() {
for msg in [
Error::Invalid.to_string(),
Error::State.to_string(),
Error::Failed("context".into()).to_string(),
Error::NotFound.to_string(),
Error::NoMem.to_string(),
] {
assert!(!msg.trim().is_empty(), "empty Display message");
}
assert!(
Error::Failed("context".into())
.to_string()
.contains("context")
);
}
/// `Error` must be usable behind a trait object.
#[test]
fn error_is_object_safe() {
let errs: Vec<Box<dyn std::error::Error>> = vec![
Box::new(Error::Invalid),
Box::new(Error::State),
Box::new(Error::Failed("context".into())),
Box::new(Error::NotFound),
Box::new(Error::NoMem),
];
assert_eq!(errs.len(), 5);
}
/// No variant wraps a downstream error, so `source()` stays `None`.
#[test]
fn source_is_none() {
assert!(std::error::Error::source(&Error::Failed("context".into())).is_none());
}
/// The `code()` mapping must be unchanged by the `Error` trait impl.
#[test]
fn code_mapping_unchanged() {
assert_eq!(Error::Invalid.code(), OAKAUDIO_E_INVALID);
assert_eq!(Error::State.code(), OAKAUDIO_E_STATE);
assert_eq!(Error::Failed("context".into()).code(), OAKAUDIO_E_FAILED);
assert_eq!(Error::NotFound.code(), OAKAUDIO_E_NOT_FOUND);
assert_eq!(Error::NoMem.code(), OAKAUDIO_E_NOMEM);
}
}