Skip to main content

YogApi

Struct YogApi 

Source
#[repr(C)]
pub struct YogApi { pub abi_version: u32, pub size: u32, pub bus: *const YogBus, pub gfx: unsafe extern "C" fn() -> *const YogGfxApi, }
Expand description

Stable C ABI — re-exported so mods don’t need a direct yog-abi dependency. Passed to yog_mod_register: the bus — everything a mod does goes through it (docs/design/bus.md) — and the one thing that can’t afford a message, the frame’s graphics.

When mods compiled against ABI N load on a runtime with ABI M > N: fields beyond size are not present in the mod’s view — check size before accessing fields added in later minor versions.

Fields§

§abi_version: u32§size: u32

sizeof(YogApi) at the runtime’s build time.

§bus: *const YogBus

The bus: calls, events and services by address (docs/design/bus.md). Valid for the runtime’s lifetime.

§gfx: unsafe extern "C" fn() -> *const YogGfxApi

The frame’s graphics while a render event (yog:event/client/render/…) runs on this thread; null otherwise. Valid until the event’s handlers return.

Trait Implementations§

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.