inspector
Generated Rust API reference for byte_engine.
Module inspector
Runtime inspection contracts and protocol-facing state access.
DefaultInspector exposes factory-created handles, their tracked
properties, application controls, screenshots, per-tick performance
metrics, and passive message publication headers without choosing a
transport. Untracked application values and published payloads remain opaque.
Contents
Quick Reference
| Item | Kind | Description |
|---|---|---|
RegisteredMessageType | struct | |
ScreenshotSelection | struct | |
Screenshots | struct | |
DebugDataStream | struct | |
DebugDataStreamWriter | struct | |
InspectedMessage | struct | The InspectedMessage struct resolves one passive publication to its scope and Rust message type. |
InspectedEntity | struct | The InspectedEntity struct describes one current entity and the properties the inspector tracks for it. |
DefaultInspector | struct | The DefaultInspector struct owns engine controls and runtime diagnostics shared by protocol adapters. |
ScreenshotCapture | enum | |
ScreenshotError | enum | |
ScreenshotFormat | enum | |
ScreenshotSubmitError | enum | |
InspectedValue | enum | The InspectedValue enum carries one tracked property value in a transport-neutral form. |
Inspectable | trait | The [Inspectable] trait defines the read and mutation surface exposed to external engine tooling. |
ScreenshotResponse | type | |
DELETE_MESSAGE_TYPE | const | |
DESTROY_MESSAGE_TYPE | const | |
TRANSFORMATION_UPDATE_MESSAGE_TYPE | const | |
TRIGGER_ACTION_MESSAGE_TYPE | const | |
MAX_SCREENSHOT_CAPTURES | const |
Structs
RegisteredMessageType<'a>
struct RegisteredMessageType<'a> {
pub message_type: &'static str,
pub payload_shape: &'a serde_json::Value,
}Defined in crates/byte-engine/src/inspector/message.rs:21-28
The RegisteredMessageType struct describes one message type accepted by an inspector protocol adapter.
Use payload_shape to build controls for the JSON payload, then
send the completed value through DefaultInspector::post_message.
Fields
-
message_type:&'static strThe stable name used in the message envelope's
typefield. -
payload_shape:&'a serde_json::ValueThe cached JSON-oriented shape of the message envelope's
payloadfield.
Trait Implementations
impl ArchivePointee for RegisteredMessageType<'a>
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for RegisteredMessageType<'a>
impl Clone for RegisteredMessageType<'a>
-
fn clone(&self) -> RegisteredMessageType<'a>Related:
RegisteredMessageType
impl Copy for RegisteredMessageType<'a>
impl Debug for RegisteredMessageType<'a>
-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for RegisteredMessageType<'a>
-
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 DowncastSync for RegisteredMessageType<'a>
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for RegisteredMessageType<'a>
impl LayoutRaw for RegisteredMessageType<'a>
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for RegisteredMessageType<'a>
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointee for RegisteredMessageType<'a>
-
type Metadata = ()
impl Read for RegisteredMessageType<'a>
impl Serialize for RegisteredMessageType<'a>
-
fn serialize<__S>(&self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
impl WithSubscriber for RegisteredMessageType<'a>
ScreenshotSelection
struct ScreenshotSelection {
pub sink: usize,
pub capture: ScreenshotCapture,
}Defined in crates/byte-engine/src/inspector/screenshot.rs:74-79
The ScreenshotSelection struct names one image to capture, so a request can mix sinks and capture points.
Fields
-
sink:usizeThe zero-based renderer sink, which is the window index.
-
capture:ScreenshotCaptureWhere in the frame the image is read from.
Trait Implementations
impl ArchivePointee for ScreenshotSelection
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ScreenshotSelection
impl Clone for ScreenshotSelection
-
fn clone(&self) -> ScreenshotSelectionRelated:
ScreenshotSelection
impl Debug for ScreenshotSelection
-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ScreenshotSelection
-
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 DowncastSync for ScreenshotSelection
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Eq for ScreenshotSelection
impl<K> Equivalent for ScreenshotSelection
-
fn equivalent(&self, key: &K) -> bool
impl Instrument for ScreenshotSelection
impl LayoutRaw for ScreenshotSelection
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ScreenshotSelection
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for ScreenshotSelection
-
fn eq(&self, other: &ScreenshotSelection) -> boolRelated:
ScreenshotSelection
impl Pointee for ScreenshotSelection
-
type Metadata = ()
impl Read for ScreenshotSelection
impl StructuralPartialEq for ScreenshotSelection
impl WithSubscriber for ScreenshotSelection
Screenshots
struct Screenshots {
pub frame: u64,
pub captures: Vec<Result<ghi::TextureReadback, ScreenshotError>>,
}Defined in crates/byte-engine/src/inspector/screenshot.rs:119-124
The Screenshots struct carries the readbacks of one request, which all come from the same graphics submission.
Fields
-
frame:u64The graphics submission that produced every capture.
-
captures:Vec<Result<ghi::TextureReadback, ScreenshotError>>One result per requested capture, in request order.
Trait Implementations
impl ArchivePointee for Screenshots
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Screenshots
impl Downcast for Screenshots
-
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 DowncastSync for Screenshots
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for Screenshots
impl LayoutRaw for Screenshots
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for Screenshots
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointee for Screenshots
-
type Metadata = ()
impl Read for Screenshots
impl WithSubscriber for Screenshots
DebugDataStream
struct DebugDataStream {
// [REDACTED: Private Fields]
}Defined in crates/byte-engine/src/inspector/stream.rs:32-35
The DebugDataStream struct requests debugging records for one entity from systems that hold its state.
Spawn it with world.create(DebugDataStream::new(entity, "Character")) after creating the consuming systems.
The debug.streams destination enables reporting. Deleting this DDS entity stops its records.
Implementations
-
fn new(entity: Handle, name: impl Into<Cow<'static, str>>) -> SelfRequests records for
entity, labelednamein every record.
Trait Implementations
impl ArchivePointee for DebugDataStream
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for DebugDataStream
impl Clone for DebugDataStream
-
fn clone(&self) -> DebugDataStreamRelated:
DebugDataStream
impl Downcast for DebugDataStream
-
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 DowncastSync for DebugDataStream
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for DebugDataStream
impl LayoutRaw for DebugDataStream
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for DebugDataStream
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointee for DebugDataStream
-
type Metadata = ()
impl Read for DebugDataStream
impl WithSubscriber for DebugDataStream
DebugDataStreamWriter
struct DebugDataStreamWriter {
// [REDACTED: Private Fields]
}Defined in crates/byte-engine/src/inspector/stream.rs:140-148
The DebugDataStreamWriter struct keeps a system's record buffers and its connection to the debug destination.
Listen for its creation on the world scope after a DebugDataStream is spawned. Use Self::entity to
match it to your system's state, then call Self::write after each update. Each clone has independent
record and change-detection buffers.
Implementations
-
fn entity(&self) -> HandleReturns the entity whose state this writer reports.
-
fn write(&mut self, stream: &str, key: &impl Serialize, data: &impl Serialize)Writes
dataas one record ofstream, the name of the system writing it.keyis the part of the system's state whose change warrants a record: withdebug.streams.changes-onlyset, a record whose key matches the last one written is skipped. It blocks until the destination takes the
whole line, so a slow reader slows the system instead of losing records.
Trait Implementations
impl ArchivePointee for DebugDataStreamWriter
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for DebugDataStreamWriter
impl Clone for DebugDataStreamWriter
-
fn clone(&self) -> Self
impl Downcast for DebugDataStreamWriter
-
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 DowncastSync for DebugDataStreamWriter
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for DebugDataStreamWriter
impl LayoutRaw for DebugDataStreamWriter
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for DebugDataStreamWriter
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointee for DebugDataStreamWriter
-
type Metadata = ()
impl Read for DebugDataStreamWriter
impl WithSubscriber for DebugDataStreamWriter
InspectedMessage
struct InspectedMessage {
pub topic_id: usize,
pub scope: Box<str>,
pub message_type: &'static str,
pub first_sequence: u64,
pub count: u64,
}Defined in crates/byte-engine/src/inspector/mod.rs:76-89
The InspectedMessage struct resolves one passive publication to its scope and Rust message type.
Fields
-
topic_id:usizeThe stable bus-local route identifier.
-
scope:Box<str>The diagnostic name of the route's owning scope.
-
message_type:&'static strThe complete Rust type name, including generic arguments.
-
first_sequence:u64The first zero-based publication sequence in this range.
-
count:u64The 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
-
fn clone(&self) -> InspectedMessageRelated:
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 DowncastSync for InspectedMessage
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
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
-
fn eq(&self, other: &InspectedMessage) -> boolRelated:
InspectedMessage
impl Pointee for InspectedMessage
-
type Metadata = ()
impl Read for InspectedMessage
impl Serialize for InspectedMessage
-
fn serialize<__S>(&self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
impl StructuralPartialEq for InspectedMessage
impl WithSubscriber for InspectedMessage
InspectedEntity
struct InspectedEntity {
// [REDACTED: Private Fields]
}Defined in crates/byte-engine/src/inspector/mod.rs:95-98
The InspectedEntity struct describes one current entity and the properties the inspector tracks for it.
Read a property by its protocol name with Self::property.
Implementations
-
fn handle(&self) -> HandleReturns the stable identity shared by the entity's representations.
-
fn types(&self) -> &[&'static str]Returns the Rust type names in their first-published order.
-
fn property(&self, name: &str) -> Option<InspectedValue<'_>>Related:
InspectedValueReturns the tracked property with this protocol name, such as
nameorposition, when the entity has it.
Trait Implementations
impl ArchivePointee for InspectedEntity
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for InspectedEntity
impl Clone for InspectedEntity
-
fn clone(&self) -> InspectedEntityRelated:
InspectedEntity
impl Debug for InspectedEntity
-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for InspectedEntity
-
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 DowncastSync for InspectedEntity
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for InspectedEntity
impl LayoutRaw for InspectedEntity
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for InspectedEntity
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for InspectedEntity
-
fn eq(&self, other: &InspectedEntity) -> boolRelated:
InspectedEntity
impl Pointee for InspectedEntity
-
type Metadata = ()
impl Read for InspectedEntity
impl Serialize for InspectedEntity
-
fn serialize<S: Serializer>(&self, serializer: S) -> Result<<S as >::Ok, <S as >::Error>
impl StructuralPartialEq for InspectedEntity
impl WithSubscriber for InspectedEntity
DefaultInspector
struct DefaultInspector {
// [REDACTED: Private Fields]
}Defined in crates/byte-engine/src/inspector/mod.rs:179-191
The DefaultInspector struct owns engine controls and runtime diagnostics shared by protocol adapters.
Implementations
-
fn register_message<M>(&mut self, message_type: &'static str, channel: DefaultChannel<M>) -> Result<(), String>Registers one reflected targeted message and its destination channel for protocol posting.
Create the channel's listeners before registration. The channel may belong
to any scope on the shared message bus. Next, share the inspector with a protocol
adapter such as
HttpInspectorServer. -
fn message_types(&self) -> Vec<RegisteredMessageType<'_>>Related:
RegisteredMessageTypeReturns registered protocol message types in stable name order.
-
fn post_message(&self, message_type: &str, target: Handle, payload: &str) -> Result<(), String>Publishes one registered targeted world message from its JSON
payloadtext.Transports pass the payload exactly as received after parsing the message envelope.
Trait Implementations
impl ArchivePointee for DefaultInspector
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for DefaultInspector
impl Downcast for DefaultInspector
-
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 DowncastSync for DefaultInspector
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for DefaultInspector
impl LayoutRaw for DefaultInspector
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for DefaultInspector
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointee for DefaultInspector
-
type Metadata = ()
impl Read for DefaultInspector
impl WithSubscriber for DefaultInspector
Enums
ScreenshotCapture
enum ScreenshotCapture {
FinalSwapchain,
AfterPass {
pass: String,
target: String,
},
SceneTarget {
target: String,
},
PreviousSceneTarget {
target: String,
},
}Defined in crates/byte-engine/src/inspector/screenshot.rs:83-103
The ScreenshotCapture enum identifies where a screenshot is transferred from.
Variants
-
SceneTargetA named render-graph target of a scene pipeline, such as an intermediate lighting buffer.
The renderer reads it after every scene pipeline has recorded its work for the frame, before post-processing.
-
PreviousSceneTargetThe copy of a history target that the previous frame wrote, which is what this frame's passes read as history.
Only targets created with
create_history_targetkeep one. The copy holds no usable data on a sink's first frame or right after a resize.
Trait Implementations
impl ArchivePointee for ScreenshotCapture
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ScreenshotCapture
impl Clone for ScreenshotCapture
-
fn clone(&self) -> ScreenshotCaptureRelated:
ScreenshotCapture
impl Debug for ScreenshotCapture
-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ScreenshotCapture
-
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 DowncastSync for ScreenshotCapture
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Eq for ScreenshotCapture
impl<K> Equivalent for ScreenshotCapture
-
fn equivalent(&self, key: &K) -> bool
impl Instrument for ScreenshotCapture
impl LayoutRaw for ScreenshotCapture
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ScreenshotCapture
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for ScreenshotCapture
-
fn eq(&self, other: &ScreenshotCapture) -> boolRelated:
ScreenshotCapture
impl Pointee for ScreenshotCapture
-
type Metadata = ()
impl Read for ScreenshotCapture
impl StructuralPartialEq for ScreenshotCapture
impl WithSubscriber for ScreenshotCapture
ScreenshotError
enum ScreenshotError {
SinkNotFound,
SinkUnavailable,
PassNotFound,
PassAmbiguous,
TargetNotWritten,
TargetHasNoHistory,
Internal(String),
}Defined in crates/byte-engine/src/inspector/screenshot.rs:128-137
Errors reported while capturing a screenshot.
Variants
-
TargetHasNoHistoryThe target exists but keeps no copy from the previous frame.
Trait Implementations
impl ArchivePointee for ScreenshotError
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ScreenshotError
impl Debug for ScreenshotError
-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ScreenshotError
-
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 DowncastSync for ScreenshotError
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for ScreenshotError
impl LayoutRaw for ScreenshotError
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ScreenshotError
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointee for ScreenshotError
-
type Metadata = ()
impl Read for ScreenshotError
impl WithSubscriber for ScreenshotError
ScreenshotFormat
enum ScreenshotFormat {
Png,
Exr,
Raw,
}Defined in crates/byte-engine/src/inspector/screenshot.rs:167-176
The ScreenshotFormat enum selects how a transport encodes a readback, trading viewer support for precision.
Variants
-
PngAn 8-bit RGBA PNG. HDR values are clamped to
[0, 1], so use it to preview images. -
ExrA lossless OpenEXR image with the texture's own precision: half floats stay half floats, normalized values become linear 32-bit floats, and
U32staysU32. Use it to inspect HDR and high-precision targets. -
RawThe texture bytes exactly as the GPU stores them, with
bytes_per_rowrow pitch.
Implementations
-
fn encode(self, readback: ghi::TextureReadback) -> Result<Vec<u8>, String>Encodes one readback.
Self::Rawreturns the readback bytes without copying them. -
fn content_type(self) -> &'static strReturns the media type of an image encoded in this format.
-
fn extension(self) -> &'static strReturns the file extension of an image encoded in this format.
Trait Implementations
impl ArchivePointee for ScreenshotFormat
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ScreenshotFormat
impl Clone for ScreenshotFormat
-
fn clone(&self) -> ScreenshotFormatRelated:
ScreenshotFormat
impl Copy for ScreenshotFormat
impl Debug for ScreenshotFormat
-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Default for ScreenshotFormat
-
fn default() -> ScreenshotFormatRelated:
ScreenshotFormat
impl Downcast for ScreenshotFormat
-
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 DowncastSync for ScreenshotFormat
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Eq for ScreenshotFormat
impl<K> Equivalent for ScreenshotFormat
-
fn equivalent(&self, key: &K) -> bool
impl Instrument for ScreenshotFormat
impl LayoutRaw for ScreenshotFormat
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ScreenshotFormat
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for ScreenshotFormat
-
fn eq(&self, other: &ScreenshotFormat) -> boolRelated:
ScreenshotFormat
impl Pointee for ScreenshotFormat
-
type Metadata = ()
impl Read for ScreenshotFormat
impl<R> ReadPrimitive for ScreenshotFormat
impl StructuralPartialEq for ScreenshotFormat
impl WithSubscriber for ScreenshotFormat
ScreenshotSubmitError
enum ScreenshotSubmitError {
QueueFull,
CaptureCount,
}Defined in crates/byte-engine/src/inspector/screenshot.rs:144-148
Errors reported before a screenshot request enters the graphics queue.
Variants
-
CaptureCountThe request selects no captures, or more than
MAX_SCREENSHOT_CAPTURES.
Trait Implementations
impl ArchivePointee for ScreenshotSubmitError
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ScreenshotSubmitError
impl Debug for ScreenshotSubmitError
-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ScreenshotSubmitError
-
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 DowncastSync for ScreenshotSubmitError
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for ScreenshotSubmitError
impl LayoutRaw for ScreenshotSubmitError
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ScreenshotSubmitError
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointee for ScreenshotSubmitError
-
type Metadata = ()
impl Read for ScreenshotSubmitError
impl WithSubscriber for ScreenshotSubmitError
InspectedValue<'a>
enum InspectedValue<'a> {
Text(&'a str),
Point(math::Point),
}Defined in crates/byte-engine/src/inspector/mod.rs:102-107
The InspectedValue enum carries one tracked property value in a transport-neutral form.
Variants
-
TextText, such as an attached
Name. -
PointA world-space location, serialized as
[x, y, z].
Trait Implementations
impl ArchivePointee for InspectedValue<'a>
-
type ArchivedMetadata = () -
fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for InspectedValue<'a>
impl Clone for InspectedValue<'a>
-
fn clone(&self) -> InspectedValue<'a>Related:
InspectedValue
impl Copy for InspectedValue<'a>
impl Debug for InspectedValue<'a>
-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for InspectedValue<'a>
-
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 DowncastSync for InspectedValue<'a>
-
fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for InspectedValue<'a>
impl LayoutRaw for InspectedValue<'a>
-
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for InspectedValue<'a>
-
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool -
fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for InspectedValue<'a>
-
fn eq(&self, other: &InspectedValue<'a>) -> boolRelated:
InspectedValue
impl Pointee for InspectedValue<'a>
-
type Metadata = ()
impl Read for InspectedValue<'a>
impl Serialize for InspectedValue<'_>
-
fn serialize<S: Serializer>(&self, serializer: S) -> Result<<S as >::Ok, <S as >::Error>
impl StructuralPartialEq for InspectedValue<'a>
impl WithSubscriber for InspectedValue<'a>
Traits
Inspectable
trait Inspectable: Send + Sync { ... }Defined in crates/byte-engine/src/inspector/mod.rs:56-72
The Inspectable trait defines the read and mutation surface exposed to
external engine tooling.
Required Methods
-
fn as_string(&self) -> StringReturns a display string for inspection responses.
Provided Methods
-
fn class_name(&self) -> &'static strReturns 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
Type Aliases
ScreenshotResponse
type ScreenshotResponse = std::sync::mpsc::Receiver<Screenshots>;Defined in crates/byte-engine/src/inspector/screenshot.rs:140
The response returned to a transport after it queues one screenshot request.
Constants
DELETE_MESSAGE_TYPE
const DELETE_MESSAGE_TYPE: &str;Defined in crates/byte-engine/src/inspector/message.rs:39
The stable inspection-protocol name for a terminal entity deletion.
DESTROY_MESSAGE_TYPE
const DESTROY_MESSAGE_TYPE: &str;Defined in crates/byte-engine/src/inspector/message.rs:41
The alternate inspection-protocol name for a terminal entity deletion.
TRANSFORMATION_UPDATE_MESSAGE_TYPE
const TRANSFORMATION_UPDATE_MESSAGE_TYPE: &str;Defined in crates/byte-engine/src/inspector/message.rs:37
The stable inspection-protocol name for a transform replacement message.
TRIGGER_ACTION_MESSAGE_TYPE
const TRIGGER_ACTION_MESSAGE_TYPE: &str;Defined in crates/byte-engine/src/inspector/message.rs:43
The stable inspection-protocol name for a posted input action.
MAX_SCREENSHOT_CAPTURES
const MAX_SCREENSHOT_CAPTURES: usize = 16usize;Defined in crates/byte-engine/src/inspector/screenshot.rs:23
The maximum number of captures one request can select.
Each capture holds a CPU-readable copy of its image until the transport encodes it, so this bounds the memory one request can pin.