Enum OxiError 

pub enum OxiError {
    Io(Error),
    Parse {
        offset: u64,
        message: String,
    },
    Codec(String),
    Unsupported(String),
    PatentViolation(String),
    Eof,
    BufferTooSmall {
        needed: usize,
        have: usize,
    },
    UnexpectedEof,
    InvalidData(String),
    UnknownFormat,
}

Error type for OxiMedia operations.

This enum covers all possible errors that can occur during multimedia processing, including I/O errors, parsing errors, codec errors, and patent violations.

Examples

use oximedia_core::error::{OxiError, OxiResult};

fn parse_data(data: &[u8]) -> OxiResult<()> {
    if data.is_empty() {
        return Err(OxiError::Parse {
            offset: 0,
            message: "Empty data".to_string(),
        });
    }
    Ok(())
}

Variants

Io(Error)

I/O error during file or stream operations.

Parse

Parse error at a specific offset in the data.

Fields

offset: u64

Byte offset where the error occurred.

message: String

Description of the parse error.

Codec(String)

Codec-related error.

Unsupported(String)

Unsupported format or feature.

PatentViolation(String)

Attempted to use a patent-encumbered codec.

OxiMedia only supports patent-free (Green List) codecs. This error is returned when attempting to use codecs like H.264, H.265, AAC, etc.

Eof

End of stream reached.

BufferTooSmall

Buffer is too small for the requested operation.

Fields

needed: usize

Required buffer size in bytes.

have: usize

Available buffer size in bytes.

UnexpectedEof

Unexpected end of file during read operation.

This is returned when attempting to read beyond the end of available data.

InvalidData(String)

Invalid data encountered during parsing.

UnknownFormat

Format could not be recognized.

Implementations

impl OxiError

pub fn parse(offset: u64, message: impl Into<String>) -> Self

Creates a new parse error at the given offset.

Examples

use oximedia_core::error::OxiError;

let err = OxiError::parse(42, "Invalid header");
assert!(matches!(err, OxiError::Parse { offset: 42, .. }));

pub fn codec(message: impl Into<String>) -> Self

Creates a new codec error.

Examples

use oximedia_core::error::OxiError;

let err = OxiError::codec("Invalid frame data");
assert!(matches!(err, OxiError::Codec(_)));

pub fn unsupported(message: impl Into<String>) -> Self

Creates a new unsupported format error.

Examples

use oximedia_core::error::OxiError;

let err = OxiError::unsupported("H.265 is not supported");
assert!(matches!(err, OxiError::Unsupported(_)));

pub fn patent_violation(codec_name: impl Into<String>) -> Self

Creates a new patent violation error.

Examples

use oximedia_core::error::OxiError;

let err = OxiError::patent_violation("H.264");
assert!(matches!(err, OxiError::PatentViolation(_)));

pub fn buffer_too_small(needed: usize, have: usize) -> Self

Creates a buffer too small error.

Examples

use oximedia_core::error::OxiError;

let err = OxiError::buffer_too_small(1024, 512);
assert!(matches!(err, OxiError::BufferTooSmall { needed: 1024, have: 512 }));

pub const fn is_eof(&self) -> bool

Returns true if this is an end-of-stream error.

Examples

use oximedia_core::error::OxiError;

assert!(OxiError::Eof.is_eof());
assert!(!OxiError::codec("test").is_eof());

pub const fn is_patent_violation(&self) -> bool

Returns true if this is a patent violation error.

Examples

use oximedia_core::error::OxiError;

assert!(OxiError::patent_violation("H.264").is_patent_violation());
assert!(!OxiError::Eof.is_patent_violation());

pub fn invalid_data(message: impl Into<String>) -> Self

Creates an invalid data error.

Examples

use oximedia_core::error::OxiError;

let err = OxiError::invalid_data("Malformed header");
assert!(matches!(err, OxiError::InvalidData(_)));

pub const fn is_unexpected_eof(&self) -> bool

Returns true if this is an unexpected EOF error.

Examples

use oximedia_core::error::OxiError;

assert!(OxiError::UnexpectedEof.is_unexpected_eof());
assert!(!OxiError::Eof.is_unexpected_eof());

Trait Implementations

impl Debug for OxiError

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

Formats the value using the given formatter.

impl Display for OxiError

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

Formats the value using the given formatter.

impl Error for OxiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for OxiError

fn from(source: Error) -> Self

Converts to this type from the input type.