Byte Engine Docs
View on docs.rs

configuration

Generated Rust API reference for byte_engine.

byte_engine / configuration


Module configuration

Asynchronous configuration messages used by debugging adapters and engine systems.

Create a Configuration, register one ConfigurationPort for each owned parameter prefix, then submit updates with Configuration::update. The consuming system keeps each update pending until it can report either ConfigurationUpdateState::Set or ConfigurationUpdateState::NotSet.

Quick Reference

ItemKindDescription
ConfigurationEventIdstructThe ConfigurationEventId struct identifies one configuration update from submission through application.
ConfigurationEventstructThe ConfigurationEvent struct provides the requested value and latest application state for debugging tools.
ConfigurationUpdatestructThe ConfigurationUpdate struct transfers one requested value to the system that owns its parameter prefix.
ConfigurationstructThe Configuration struct routes configuration messages while retaining their latest state for debugging tools.
ConfigurationPortstructThe ConfigurationPort struct gives one consuming system an update queue and result-reporting handle.
ConfigurationValueenumThe ConfigurationValue enum carries the small set of values shared by configuration adapters and systems.
ConfigurationUpdateStateenumThe ConfigurationUpdateState enum reports the current application result for one configuration event.

Structs

ConfigurationEventId

struct ConfigurationEventId();

Defined in crates/byte-engine/src/configuration.rs:24

The ConfigurationEventId struct identifies one configuration update from submission through application.

Trait Implementations

impl ArchivePointee for ConfigurationEventId
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ConfigurationEventId
impl Clone for ConfigurationEventId
impl Copy for ConfigurationEventId
impl Debug for ConfigurationEventId
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ConfigurationEventId
  • 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 ConfigurationEventId
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Eq for ConfigurationEventId
impl<K> Equivalent for ConfigurationEventId
  • fn equivalent(&self, key: &K) -> bool
impl Hash for ConfigurationEventId
  • fn hash<__H: hash::Hasher>(&self, state: &mut __H)
impl Instrument for ConfigurationEventId
impl LayoutRaw for ConfigurationEventId
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ConfigurationEventId
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for ConfigurationEventId
impl Pointee for ConfigurationEventId
  • type Metadata = ()
impl Read for ConfigurationEventId
impl Serialize for ConfigurationEventId
  • fn serialize<__S>(&self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
impl StructuralPartialEq for ConfigurationEventId
impl WithSubscriber for ConfigurationEventId

ConfigurationEvent

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

Defined in crates/byte-engine/src/configuration.rs:115-120

The ConfigurationEvent struct provides the requested value and latest application state for debugging tools.

Implementations

  • fn id(&self) -> ConfigurationEventId

    Related: ConfigurationEventId

    Returns the identifier assigned when this update was submitted.

  • fn parameter(&self) -> &str

    Returns the discoverable parameter name.

  • fn requested(&self) -> &ConfigurationValue

    Related: ConfigurationValue

    Returns the value requested by the producer.

  • fn state(&self) -> &ConfigurationUpdateState

    Related: ConfigurationUpdateState

    Returns the latest state reported by the owning system.

Trait Implementations

impl ArchivePointee for ConfigurationEvent
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ConfigurationEvent
impl Clone for ConfigurationEvent
impl Debug for ConfigurationEvent
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ConfigurationEvent
  • 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 ConfigurationEvent
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for ConfigurationEvent
impl LayoutRaw for ConfigurationEvent
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ConfigurationEvent
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for ConfigurationEvent
impl Pointee for ConfigurationEvent
  • type Metadata = ()
impl Read for ConfigurationEvent
impl Serialize for ConfigurationEvent
  • fn serialize<__S>(&self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
impl StructuralPartialEq for ConfigurationEvent
impl WithSubscriber for ConfigurationEvent

ConfigurationUpdate

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

Defined in crates/byte-engine/src/configuration.rs:146-150

The ConfigurationUpdate struct transfers one requested value to the system that owns its parameter prefix.

Implementations

  • fn id(&self) -> ConfigurationEventId

    Related: ConfigurationEventId

    Returns the event identifier used to report the application result.

  • fn parameter(&self) -> &str

    Returns the parameter name inside the prefix the receiving port registered, so a system reads its

    parameters by their own names wherever its caller placed them.

  • fn value(&self) -> &ConfigurationValue

    Related: ConfigurationValue

    Returns the requested parameter value.

Trait Implementations

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

Configuration

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

Defined in crates/byte-engine/src/configuration.rs:183-185

The Configuration struct routes configuration messages while retaining their latest state for debugging tools.

Implementations

  • fn new() -> Self

    Creates an empty configuration exchange.

    Next, call Self::register before submitting matching updates through

    Self::update.

  • fn register(&self, prefix: &str) -> ConfigurationPort

    Related: ConfigurationPort

    Registers the system that owns parameters beginning with prefix, which the caller chooses: the port

    delivers each parameter by the rest of its name.

    Next, keep the returned port with that system and call

    ConfigurationPort::read when the system is ready to queue updates.

  • fn update(&self, parameter: impl Into<String>, value: impl Into<ConfigurationValue>) -> ConfigurationEventId

    Related: ConfigurationValue, ConfigurationEventId

    Queues a value for the system that owns the longest matching parameter prefix.

    The returned event starts as pending. Use Self::event to inspect the

    system-reported result later.

  • fn event(&self, id: ConfigurationEventId) -> Option<ConfigurationEvent>

    Related: ConfigurationEventId, ConfigurationEvent

    Returns the latest state for one configuration event.

  • fn events(&self) -> Vec<ConfigurationEvent>

    Related: ConfigurationEvent

    Returns a snapshot of all retained configuration events.

Trait Implementations

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

ConfigurationPort

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

Defined in crates/byte-engine/src/configuration.rs:296-299

The ConfigurationPort struct gives one consuming system an update queue and result-reporting handle.

Implementations

  • fn read(&self) -> Option<ConfigurationUpdate>

    Related: ConfigurationUpdate

    Returns the next queued update without waiting for a producer.

  • fn set(&self, id: ConfigurationEventId, value: ConfigurationValue)

    Related: ConfigurationEventId, ConfigurationValue

    Reports the effective value applied by the consuming system.

  • fn not_set(&self, id: ConfigurationEventId, reason: impl Into<String>)

    Related: ConfigurationEventId

    Reports why the consuming system did not apply the requested value.

Trait Implementations

impl ArchivePointee for ConfigurationPort
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ConfigurationPort
impl Downcast for ConfigurationPort
  • 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 Instrument for ConfigurationPort
impl LayoutRaw for ConfigurationPort
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ConfigurationPort
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointee for ConfigurationPort
  • type Metadata = ()
impl Read for ConfigurationPort
impl WithSubscriber for ConfigurationPort

Enums

ConfigurationValue

enum ConfigurationValue {
    Bool(bool),
    Integer(i64),
    Float(f64),
    Text(String),
}

Defined in crates/byte-engine/src/configuration.rs:29-38

The ConfigurationValue enum carries the small set of values shared by configuration adapters and systems.

Variants

  • Bool

    A Boolean configuration value.

  • Integer

    A signed integer configuration value.

  • Float

    A floating-point configuration value.

  • Text

    An owned text configuration value.

Implementations

  • fn as_text(&self) -> Option<&str>

    Returns the text value expected by string-backed configuration consumers.

Trait Implementations

impl ArchivePointee for ConfigurationValue
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ConfigurationValue
impl Clone for ConfigurationValue
impl Debug for ConfigurationValue
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ConfigurationValue
  • 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 ConfigurationValue
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for ConfigurationValue
impl LayoutRaw for ConfigurationValue
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ConfigurationValue
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for ConfigurationValue
impl Pointee for ConfigurationValue
  • type Metadata = ()
impl Read for ConfigurationValue
impl Serialize for ConfigurationValue
  • fn serialize<__S>(&self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
impl StructuralPartialEq for ConfigurationValue
impl WithSubscriber for ConfigurationValue

ConfigurationUpdateState

enum ConfigurationUpdateState {
    Pending,
    Set {
        value: ConfigurationValue,
    },
    NotSet {
        reason: String,
    },
}

Defined in crates/byte-engine/src/configuration.rs:98-111

The ConfigurationUpdateState enum reports the current application result for one configuration event.

Variants

  • Pending

    The owning system has not processed the update yet.

  • Set

    The owning system applied the update.

  • NotSet

    The owning system rejected or could not apply the update.

Trait Implementations

impl ArchivePointee for ConfigurationUpdateState
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ConfigurationUpdateState
impl Clone for ConfigurationUpdateState
impl Debug for ConfigurationUpdateState
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ConfigurationUpdateState
  • 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 ConfigurationUpdateState
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for ConfigurationUpdateState
impl LayoutRaw for ConfigurationUpdateState
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ConfigurationUpdateState
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for ConfigurationUpdateState
impl Pointee for ConfigurationUpdateState
  • type Metadata = ()
impl Read for ConfigurationUpdateState
impl Serialize for ConfigurationUpdateState
  • fn serialize<__S>(&self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
impl StructuralPartialEq for ConfigurationUpdateState
impl WithSubscriber for ConfigurationUpdateState

On this page

Module configurationQuick ReferenceStructsConfigurationEventIdTrait Implementationsimpl ArchivePointee for ConfigurationEventIdimpl<ST> CastableFrom for ConfigurationEventIdimpl Clone for ConfigurationEventIdimpl Copy for ConfigurationEventIdimpl Debug for ConfigurationEventIdimpl Downcast for ConfigurationEventIdimpl DowncastSync for ConfigurationEventIdimpl Eq for ConfigurationEventIdimpl<K> Equivalent for ConfigurationEventIdimpl Hash for ConfigurationEventIdimpl Instrument for ConfigurationEventIdimpl LayoutRaw for ConfigurationEventIdimpl<T, N1> Niching for ConfigurationEventIdimpl PartialEq for ConfigurationEventIdimpl Pointee for ConfigurationEventIdimpl Read for ConfigurationEventIdimpl Serialize for ConfigurationEventIdimpl StructuralPartialEq for ConfigurationEventIdimpl WithSubscriber for ConfigurationEventIdConfigurationEventImplementationsTrait Implementationsimpl ArchivePointee for ConfigurationEventimpl<ST> CastableFrom for ConfigurationEventimpl Clone for ConfigurationEventimpl Debug for ConfigurationEventimpl Downcast for ConfigurationEventimpl DowncastSync for ConfigurationEventimpl Instrument for ConfigurationEventimpl LayoutRaw for ConfigurationEventimpl<T, N1> Niching for ConfigurationEventimpl PartialEq for ConfigurationEventimpl Pointee for ConfigurationEventimpl Read for ConfigurationEventimpl Serialize for ConfigurationEventimpl StructuralPartialEq for ConfigurationEventimpl WithSubscriber for ConfigurationEventConfigurationUpdateImplementationsTrait Implementationsimpl ArchivePointee for ConfigurationUpdateimpl<ST> CastableFrom for ConfigurationUpdateimpl Clone for ConfigurationUpdateimpl Debug for ConfigurationUpdateimpl Downcast for ConfigurationUpdateimpl DowncastSync for ConfigurationUpdateimpl Instrument for ConfigurationUpdateimpl LayoutRaw for ConfigurationUpdateimpl<T, N1> Niching for ConfigurationUpdateimpl PartialEq for ConfigurationUpdateimpl Pointee for ConfigurationUpdateimpl Read for ConfigurationUpdateimpl StructuralPartialEq for ConfigurationUpdateimpl WithSubscriber for ConfigurationUpdateConfigurationImplementationsTrait Implementationsimpl ArchivePointee for Configurationimpl<ST> CastableFrom for Configurationimpl Clone for Configurationimpl Default for Configurationimpl Downcast for Configurationimpl DowncastSync for Configurationimpl Instrument for Configurationimpl LayoutRaw for Configurationimpl<T, N1> Niching for Configurationimpl Pointee for Configurationimpl Read for Configurationimpl<R> ReadPrimitive for Configurationimpl WithSubscriber for ConfigurationConfigurationPortImplementationsTrait Implementationsimpl ArchivePointee for ConfigurationPortimpl<ST> CastableFrom for ConfigurationPortimpl Downcast for ConfigurationPortimpl Instrument for ConfigurationPortimpl LayoutRaw for ConfigurationPortimpl<T, N1> Niching for ConfigurationPortimpl Pointee for ConfigurationPortimpl Read for ConfigurationPortimpl WithSubscriber for ConfigurationPortEnumsConfigurationValueVariantsImplementationsTrait Implementationsimpl ArchivePointee for ConfigurationValueimpl<ST> CastableFrom for ConfigurationValueimpl Clone for ConfigurationValueimpl Debug for ConfigurationValueimpl Downcast for ConfigurationValueimpl DowncastSync for ConfigurationValueimpl Instrument for ConfigurationValueimpl LayoutRaw for ConfigurationValueimpl<T, N1> Niching for ConfigurationValueimpl PartialEq for ConfigurationValueimpl Pointee for ConfigurationValueimpl Read for ConfigurationValueimpl Serialize for ConfigurationValueimpl StructuralPartialEq for ConfigurationValueimpl WithSubscriber for ConfigurationValueConfigurationUpdateStateVariantsTrait Implementationsimpl ArchivePointee for ConfigurationUpdateStateimpl<ST> CastableFrom for ConfigurationUpdateStateimpl Clone for ConfigurationUpdateStateimpl Debug for ConfigurationUpdateStateimpl Downcast for ConfigurationUpdateStateimpl DowncastSync for ConfigurationUpdateStateimpl Instrument for ConfigurationUpdateStateimpl LayoutRaw for ConfigurationUpdateStateimpl<T, N1> Niching for ConfigurationUpdateStateimpl PartialEq for ConfigurationUpdateStateimpl Pointee for ConfigurationUpdateStateimpl Read for ConfigurationUpdateStateimpl Serialize for ConfigurationUpdateStateimpl StructuralPartialEq for ConfigurationUpdateStateimpl WithSubscriber for ConfigurationUpdateState