Skip to main content

Runtime

Struct Runtime 

Source
pub struct Runtime { /* private fields */ }
Expand description

Handle to the running RT thread.

Owns the join handle for the spawned thread. Dropping the Runtime signals shutdown and joins the thread. Use Runtime::start to create one.

Implementations§

Source§

impl Runtime

Source

pub fn start(config: RuntimeConfig) -> Result<(Self, RtHandles), Error>

Spawns the RT thread with the given configuration.

Blocks until the thread has elevated its priority and opened all MIDI ports. Returns a Runtime handle (for lifecycle management) and RtHandles (for queue communication with the ECS world).

§Errors

Returns Error::MidiInit if MIDI ports cannot be opened, Error::PortNotFound if a configured port name has no match, or Error::PriorityElevation if RT priority cannot be obtained and RuntimeConfig::allow_normal_priority is false.

Source

pub fn stop(&mut self) -> Result<(), Error>

Gracefully shuts down the RT thread.

Sets the shutdown flag and joins the thread. This is also called automatically on Drop.

§Errors

Returns Error::AlreadyStopped if the runtime was already shut down, or Error::ThreadPanicked if the thread panicked.

Trait Implementations§

Source§

impl Debug for Runtime

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Runtime

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.