Byte Engine Docs
View on docs.rs

thread

Generated Rust API reference for byte_engine.

byte_engine / application / thread


Module thread

Worker-thread support for application-owned subsystems.

Use Thread for workers that must stop with the application. The standard headed workers show how to provide a listener from the application event bus.

Quick Reference

ItemKindDescription
ThreadstructThe [Thread] struct owns a worker that participates in application shutdown.

Structs

Thread

struct Thread {
    // [REDACTED: Private Fields]
}

Defined in crates/byte-engine/src/application/thread.rs:10-12

The Thread struct owns a worker that participates in application shutdown.

Implementations

  • fn new<F>(events: DefaultListener<Events>, f: F) -> Self

    Related: Events

    Starts an application-owned worker that receives shutdown events.

  • fn join(self) -> std::thread::Result<()>

    Waits for the worker to finish during application shutdown.

Trait Implementations

impl ArchivePointee for Thread
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Thread
impl Downcast for Thread
  • fn into_any(self: Box<T>) -> Box<dyn Any>
  • fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
  • fn as_any(&self) -> &dyn Any
  • fn as_any_mut(&mut self) -> &mut dyn Any
impl DowncastSend for Thread
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for Thread
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Instrument for Thread
impl LayoutRaw for Thread
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for Thread
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointable for Thread
  • const ALIGN: usize
  • type Init = T
  • unsafe fn init(init: <T as Pointable>::Init) -> usize
  • unsafe fn deref<'a>(ptr: usize) -> &'a T
  • unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
  • unsafe fn drop(ptr: usize)
impl Pointee for Thread
  • type Metadata = ()
impl Read for Thread
impl WithSubscriber for Thread

On this page