Struct fruity__bbqsrc::core::OSErr

#[repr(transparent)]
pub struct OSErr(_);

A non-zero 16-bit error code.

This is the old counterpart to OSStatus.

Usage

In FFI code, this type is meant to be used as Option<OSErr>. None becomes 0 (no error) because this type is #[repr(transparent)] over NonZeroI16.

Rust bindings that call Option<OSErr>-returning functions should return Result<T, OSErr>.

Implementations

impl OSErr

pub const fn new(value: i16) -> Option<Self>

Creates an instance from value, returning None if it is zero.

pub const fn new_non_zero(value: NonZeroI16) -> Self

Creates an instance from a non-zero value.

pub const unsafe fn new_unchecked(value: i16) -> Self

Creates an instance from value, without checking if it is zero.

Safety

The value must not be zero.

pub const fn from_os_status(status: OSStatus) -> Option<Self>

Converts an OSStatus instance to an OSErr if it’s within the 16-bit range.

pub const fn value(self) -> i16

Returns this error’s integer value.

pub const fn non_zero_value(self) -> NonZeroI16

Returns this error’s integer value.

impl OSErr

Apple event manager errors.

pub const AE_COERCION_FAIL: Self

Data could not be coerced to the requested descriptor type.

See documentation.

pub const AE_DESC_NOT_FOUND: Self

Descriptor was not found.

See documentation.

pub const AE_CORRUPT_DATA: Self

Data in an Apple event could not be read.

See documentation.

pub const AE_WRONG_DATA_TYPE: Self

Wrong descriptor type.

See documentation.

pub const AE_NOT_AE_DESC: Self

Not a valid descriptor.

See documentation.

pub const AE_BAD_LIST_ITEM: Self

Operation involving a list item failed.

See documentation.

pub const AE_NEWER_VERSION: Self

Need a newer version of the Apple Event Manager.

See documentation.

pub const AE_NOT_APPLE_EVENT: Self

The event is not in AppleEvent format.

See documentation.

pub const AE_EVENT_NOT_HANDLED: Self

Event wasn’t handled by an Apple event handler.

See documentation.

pub const AE_REPLY_NOT_VALID: Self

AEResetTimer was passed an invalid reply.

See documentation.

pub const AE_UNKNOWN_SEND_MODE: Self

Invalid sending mode was passed.

See documentation.

pub const AE_WAIT_CANCELED: Self

User canceled out of wait loop for reply or receipt.

See documentation.

pub const AE_TIMEOUT: Self

Apple event timed out.

See documentation.

pub const AE_NO_USER_INTERACTION: Self

No user interaction allowed.

See documentation.

pub const AE_NOT_A_SPECIAL_FUNCTION: Self

Wrong keyword for a special function.

See documentation.

pub const AE_PARAM_MISSED: Self

A required parameter was not accessed.

See documentation.

pub const AE_UNKNOWN_ADDRESS_TYPE: Self

Unknown Apple event address type.

See documentation.

pub const AE_HANDLER_NOT_FOUND: Self

No handler found for an Apple event.

See documentation.

pub const AE_REPLY_NOT_ARRIVED: Self

Reply has not yet arrived.

See documentation.

pub const AE_ILLEGAL_INDEX: Self

Not a valid list index.

See documentation.

pub const AE_IMPOSSIBLE_RANGE: Self

The range is not valid because it is impossible for a range to include the first and last objects that were specified;an example is a range in which the offset of the first object is greater than the offset of the last object.

See documentation.

pub const AE_WRONG_NUMBER_ARGS: Self

The number of operands provided for the kAENOT logical operator is not 1.

See documentation.

pub const AE_ACCESSOR_NOT_FOUND: Self

There is no object accessor function for the specified object class and container type.

See documentation.

pub const AE_NO_SUCH_LOGICAL: Self

The logical operator in a logical descriptor is not kAEAND, kAEOR,or kAENOT.

See documentation.

pub const AE_BAD_TEST_KEY: Self

The descriptor in a test key is neither a comparison descriptor nor a logical descriptor.

See documentation.

pub const AE_NOT_AN_OBJ_SPEC: Self

See documentation.

pub const AE_NO_SUCH_OBJECT: Self

Runtime resolution of an object failed.

See documentation.

pub const AE_NEGATIVE_COUNT: Self

An object-counting function returned a negative result.

See documentation.

pub const AE_EMPTY_LIST_CONTAINER: Self

The container for an Apple event object is specified by an empty list.

See documentation.

pub const AE_UNKNOWN_OBJECT_TYPE: Self

The object type isn’t recognized.

See documentation.

pub const AE_RECORDING_IS_ALREADY_ON: Self

Recording is already on.

See documentation.

pub const AE_RECEIVE_TERMINATE: Self

Break out of all levels of AEReceive to the topmost (1.1 or greater).

See documentation.

pub const AE_RECEIVE_ESCAPE_CURRENT: Self

Break out of lowest level only of AEReceive (1.1 or greater).

See documentation.

pub const AE_EVENT_FILTERED: Self

Event has been filtered and should not be propagated (1.1 or greater).

See documentation.

pub const AE_DUPLICATE_HANDLER: Self

Attempt to install handler in table for identical class and ID (1.1 or greater).

See documentation.

pub const AE_STREAM_BAD_NESTING: Self

Nesting violation while streaming.

See documentation.

pub const AE_STREAM_ALREADY_CONVERTED: Self

Attempt to convert a stream that has already been converted.

See documentation.

pub const AE_DESC_IS_NULL: Self

Attempt to perform an invalid operation on a null descriptor.

See documentation.

pub const AE_BUILD_SYNTAX_ERROR: Self

AEBuildDesc and related functions detected a syntax error.

See documentation.

pub const AE_BUFFER_TOO_SMALL: Self

Buffer for AEFlattenDesc too small.

See documentation.

Trait Implementations

impl Clone for OSErr

fn clone(&self) -> OSErr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OSErr

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

Formats the value using the given formatter.

impl From<NonZeroI16> for OSErr

fn from(value: NonZeroI16) -> Self

Performs the conversion.

impl From<OSErr> for OSStatus

fn from(error: OSErr) -> Self

Performs the conversion.

impl Hash for OSErr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for OSErr

fn cmp(&self, other: &OSErr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<OSErr> for OSErr

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<OSErr> for OSErr

fn partial_cmp(&self, other: &OSErr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for OSErr

impl Eq for OSErr

impl StructuralEq for OSErr

impl StructuralPartialEq for OSErr