Struct sptr::func::OpaqueFnPtr

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

The void* equivalent for a function pointer, for when you need to handle “some fn”.

Some platforms (WASM, AVR) have non-uniform representations for “code” and “data” pointers. Such platforms are referred to as “Harvard Architectures”.

Rust does not have a good way for talking about “some” function pointer, so it’s pretty common to cast to a usize or a raw pointer to make it easier. The entire point of strict provenance is to make you not do usize casts, so obviously we’re not a fan of that. But the other approach also isn’t great because Oxford Casts Are A Mess.

So really you want to stay in “definitely doing function pointers”, which means you want a proper opaque function pointer type. This type attempts to be that but is honestly not very good at it, because it immediately runs into the exact problem it’s trying to solve: Rust makes it really hard to talk about “some” function pointer, so we can’t actually describe its interface!

This really needs proper language support.

(In the meantime, func as usize and usize as func are genuinely the less evil casts here! Don’t do Oxford Casts if you want your code to be maximally portable!)

Implementations

impl OpaqueFnPtr

pub unsafe fn from_fn<T>(func: T) -> Self

Create an OpaqueFnPtr from some fn.

Rust doesn’t have a good way to express, so this just takes “anything” and it’s up to you to make sure you’re actually feeding in a function pointer.

If you feed in anything else, it is Undefined Behaviour.

pub unsafe fn to_fn<T>(self) -> T

Create a fn from an OpaqueFnPtr.

Rust doesn’t have a good way to express, so this just takes “anything” and it’s up to you to make sure you’re actually feeding in a function pointer type.

If you feed in anything else, it is Undefined Behaviour.

pub fn addr(self) -> usize

Get the address of the function pointer.

Note that while you can compare this to a data pointer, the result will almost certainly be meaningless, especially on platforms like WASM and AVR where function pointers are in a separate address-space from data pointers.

See pointer::addr for details.

Trait Implementations

impl Clone for OpaqueFnPtr

fn clone(&self) -> OpaqueFnPtr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpaqueFnPtr

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

Formats the value using the given formatter.

impl Hash for OpaqueFnPtr

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 OpaqueFnPtr

fn cmp(&self, other: &OpaqueFnPtr) -> 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<OpaqueFnPtr> for OpaqueFnPtr

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

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

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

This method tests for !=.

impl PartialOrd<OpaqueFnPtr> for OpaqueFnPtr

fn partial_cmp(&self, other: &OpaqueFnPtr) -> 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 OpaqueFnPtr

impl Eq for OpaqueFnPtr

impl StructuralEq for OpaqueFnPtr

impl StructuralPartialEq for OpaqueFnPtr