Byte Engine Docs
View on docs.rs

inspector

Generated Rust API reference for byte_engine.

byte_engine / inspector


Module inspector

Runtime inspection contracts and protocol-facing state access.

The Inspector exposes factory-created handles and passive message publication headers without retaining application values or published payloads. Registered post types deserialize their payloads through Facet. Protocol adapters should query this object rather than reaching into application subsystems directly.

Quick Reference

ItemKindDescription
InspectedMessagestructThe InspectedMessage struct resolves one passive publication to its scope and Rust message type.
InspectedMessageBatchstructThe InspectedMessageBatch struct carries resolved publication ranges since the prior drain.
InspectorstructThe Inspector struct owns application controls and passive runtime diagnostics shared by protocol adapters.
InspectabletraitThe [Inspectable] trait defines the read and mutation surface exposed to external engine tooling.
TRANSFORMATION_UPDATE_MESSAGE_TYPEconst

Structs

InspectedMessage

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

Defined in crates/byte-engine/src/inspector/mod.rs:55-61

The InspectedMessage struct resolves one passive publication to its scope and Rust message type.

Implementations

  • fn topic_id(&self) -> usize

    Returns the stable bus-local route identifier.

  • fn scope(&self) -> &str

    Returns the diagnostic name of the route's owning scope.

  • fn message_type(&self) -> &'static str

    Returns the complete Rust type name, including generic arguments.

  • fn first_sequence(&self) -> u64

    Returns the first zero-based publication sequence in this range.

  • fn count(&self) -> u64

    Returns the number of consecutive publications in this range.

Trait Implementations

impl ArchivePointee for InspectedMessage
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for InspectedMessage
impl Clone for InspectedMessage
impl Debug for InspectedMessage
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for InspectedMessage
  • 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 InspectedMessage
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for InspectedMessage
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Eq for InspectedMessage
impl<K> Equivalent for InspectedMessage
  • fn equivalent(&self, key: &K) -> bool
impl Instrument for InspectedMessage
impl LayoutRaw for InspectedMessage
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for InspectedMessage
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for InspectedMessage
impl Pointable for InspectedMessage
  • 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 InspectedMessage
  • type Metadata = ()
impl Read for InspectedMessage
impl StructuralPartialEq for InspectedMessage
impl WithSubscriber for InspectedMessage

InspectedMessageBatch

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

Defined in crates/byte-engine/src/inspector/mod.rs:92-94

The InspectedMessageBatch struct carries resolved publication ranges since the prior drain.

Implementations

  • fn messages(&self) -> &[InspectedMessage]

    Related: InspectedMessage

    Returns one range for each route that published since the prior drain.

Trait Implementations

impl ArchivePointee for InspectedMessageBatch
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for InspectedMessageBatch
impl Debug for InspectedMessageBatch
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for InspectedMessageBatch
  • 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 InspectedMessageBatch
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for InspectedMessageBatch
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Eq for InspectedMessageBatch
impl<K> Equivalent for InspectedMessageBatch
  • fn equivalent(&self, key: &K) -> bool
impl Instrument for InspectedMessageBatch
impl LayoutRaw for InspectedMessageBatch
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for InspectedMessageBatch
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for InspectedMessageBatch
impl Pointable for InspectedMessageBatch
  • 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 InspectedMessageBatch
  • type Metadata = ()
impl Read for InspectedMessageBatch
impl StructuralPartialEq for InspectedMessageBatch
impl WithSubscriber for InspectedMessageBatch

Inspector

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

Defined in crates/byte-engine/src/inspector/mod.rs:104-113

The Inspector struct owns application controls and passive runtime diagnostics shared by protocol adapters.

Implementations

  • fn register_message<M>(&mut self, message_type: &'static str) -> Result<(), String>

    Registers one reflected targeted message for protocol posting.

    message_type becomes the stable protocol type, and the reflected shape

    of M::Payload defines its JSON payload. Register every supported message

    before sharing the inspector with a protocol server.

  • fn post_message(&self, message_type: &str, target: Handle, payload: &Value) -> Result<(), String>

    Publishes one registered targeted world message from its protocol name and reflected JSON payload.

    Call Self::register_message for the message type before accepting posts.

Trait Implementations

impl ArchivePointee for Inspector
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Inspector
impl Downcast for Inspector
  • 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 Inspector
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for Inspector
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Instrument for Inspector
impl LayoutRaw for Inspector
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for Inspector
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointable for Inspector
  • 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 Inspector
  • type Metadata = ()
impl Read for Inspector
impl WithSubscriber for Inspector

Traits

Inspectable

trait Inspectable: Send + Sync { ... }

Defined in crates/byte-engine/src/inspector/mod.rs:35-51

The Inspectable trait defines the read and mutation surface exposed to external engine tooling.

Required Methods

  • fn as_string(&self) -> String

    Returns a display string for inspection responses.

Provided Methods

  • fn class_name(&self) -> &'static str

    Returns the class name used by inspection filters.

  • fn set(&mut self, key: &str, value: &str) -> Result<(), String>

    Applies an inspector-provided string value to a named property.

Implementors

Constants

TRANSFORMATION_UPDATE_MESSAGE_TYPE

const TRANSFORMATION_UPDATE_MESSAGE_TYPE: &str;

Defined in crates/byte-engine/src/inspector/message.rs:12

The stable inspection-protocol name for a transform replacement message.

On this page

Module inspectorQuick ReferenceStructsInspectedMessageImplementationsTrait Implementationsimpl ArchivePointee for InspectedMessageimpl<ST> CastableFrom for InspectedMessageimpl Clone for InspectedMessageimpl Debug for InspectedMessageimpl Downcast for InspectedMessageimpl DowncastSend for InspectedMessageimpl DowncastSync for InspectedMessageimpl Eq for InspectedMessageimpl<K> Equivalent for InspectedMessageimpl Instrument for InspectedMessageimpl LayoutRaw for InspectedMessageimpl<T, N1> Niching for InspectedMessageimpl PartialEq for InspectedMessageimpl Pointable for InspectedMessageimpl Pointee for InspectedMessageimpl Read for InspectedMessageimpl StructuralPartialEq for InspectedMessageimpl WithSubscriber for InspectedMessageInspectedMessageBatchImplementationsTrait Implementationsimpl ArchivePointee for InspectedMessageBatchimpl<ST> CastableFrom for InspectedMessageBatchimpl Debug for InspectedMessageBatchimpl Downcast for InspectedMessageBatchimpl DowncastSend for InspectedMessageBatchimpl DowncastSync for InspectedMessageBatchimpl Eq for InspectedMessageBatchimpl<K> Equivalent for InspectedMessageBatchimpl Instrument for InspectedMessageBatchimpl LayoutRaw for InspectedMessageBatchimpl<T, N1> Niching for InspectedMessageBatchimpl PartialEq for InspectedMessageBatchimpl Pointable for InspectedMessageBatchimpl Pointee for InspectedMessageBatchimpl Read for InspectedMessageBatchimpl StructuralPartialEq for InspectedMessageBatchimpl WithSubscriber for InspectedMessageBatchInspectorImplementationsTrait Implementationsimpl ArchivePointee for Inspectorimpl<ST> CastableFrom for Inspectorimpl Downcast for Inspectorimpl DowncastSend for Inspectorimpl DowncastSync for Inspectorimpl Instrument for Inspectorimpl LayoutRaw for Inspectorimpl<T, N1> Niching for Inspectorimpl Pointable for Inspectorimpl Pointee for Inspectorimpl Read for Inspectorimpl WithSubscriber for InspectorTraitsInspectableRequired MethodsProvided MethodsImplementorsConstantsTRANSFORMATION_UPDATE_MESSAGE_TYPE