Struct SwiftError 

pub struct SwiftError { /* private fields */ }

A Swift Error box, owned.

What throw produces and catch receives: a refcounted box holding a value and the Error conformance that describes it. Rust can make one, which is how a Rust callback answers a Swift API that wants a failure.

Implementations

impl SwiftError

pub unsafe fn new( value: *const c_void, meta: *const c_void, wt: *const c_void, ) -> Self

Box a value as an Error.

Safety

value must address an initialised value of meta’s type, and wt must be that type’s Error conformance. The value is copied into the box, so the caller keeps its own.

pub fn as_ptr(&self) -> *mut c_void

The box, for handing to Swift.

Borrowed: Swift is expected to retain it if it keeps it.

pub fn payload_type_name(&self) -> String

The type of the value inside, as the runtime spells it.

Read back out of the box rather than remembered, which is what makes this a check on swift_allocError rather than an echo of its argument.

pub unsafe fn payload(&self) -> &[u8]

The value inside, as bytes.

Safety

The slice borrows the box’s storage and is only valid while it lives.

Trait Implementations

impl Clone for SwiftError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for SwiftError

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.