Skip to main content

EmbeddedDriver

Struct EmbeddedDriver 

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

An embedded media driver running on a background thread, with a unique directory, stopped and joined automatically on Drop.

let driver = EmbeddedDriver::launch().unwrap();
// connect clients against driver.dir() ...
// driver stops + joins when it goes out of scope

Implementations§

Source§

impl EmbeddedDriver

Source

pub fn launch() -> Result<Self, AeronCError>

Launch an embedded driver in a unique directory (deleted on start and shutdown).

Source

pub fn launch_with( configure: impl FnOnce(&AeronDriverContext) -> Result<(), AeronCError>, ) -> Result<Self, AeronCError>

Launch with extra AeronDriverContext configuration (timeouts, idle strategies…) applied before the driver starts.

Source

pub fn dir(&self) -> &str

The aeron directory clients should connect to.

Source

pub fn context(&self) -> &AeronDriverContext

The driver’s context, e.g. for reading configured values.

Source

pub fn stop(self)

Stop the driver now instead of waiting for Drop.

Trait Implementations§

Source§

impl Drop for EmbeddedDriver

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.