Struct DriverLabBuilder 

pub struct DriverLabBuilder { /* private fields */ }

Builder for configuring and instantiating an EmbeddedLabServer inside an existing DFv2 driver.

Implementations

impl DriverLabBuilder

pub fn new(node_identity: impl Into<String>) -> Self

Creates a new builder for the given stable node/driver identity.

pub fn from_context(context: &DriverContext) -> Self

Creates a new builder extracting the node identity from DriverContext.

pub fn with_enabled(self, enabled: bool) -> Self

Explicitly enables or disables the embedded debug server (in release builds where enable_driver_lab = false, this defaults to false and omits outgoing service handlers).

pub fn with_allow_mutating_sessions(self, allow: bool) -> Self

Sets whether mutating sessions are permitted on this embedded server.

pub fn with_config(self, config: ProxyConfig) -> Self

Overrides the proxy configuration bounds (narrowing against baseline).

pub fn with_quiesce_hook<F>(&mut self, hook: F) -> &mut Self

where F: Fn(bool) + Send + Sync + 'static,

Registers a synchronous quiesce callback (quiesce_hook(bool paused)) invoked with true when a mutating session acquires the mutation lease and false when the session closes or the driver stops (Spec Phase 2 Section 2.2).

pub fn with_mmio( &mut self, name: impl Into<String>, vmo: &Vmo, offset: usize, size: usize, ) -> Result<ResourceId, Status>

Ergonomic helper to register a driver MMIO VMO by byte size.

pub fn with_writable_registers( &mut self, id: ResourceId, offsets: Vec<u64>, ) -> &mut Self

Configures 32-bit writable register offsets on a registered MMIO resource.

pub fn with_hard_denied_ranges( &mut self, id: ResourceId, ranges: Vec<(u64, u64)>, ) -> &mut Self

Configures hard-denied byte offset ranges (start, end) on a registered MMIO resource.

pub fn with_interrupt(&mut self, name: impl Into<String>) -> ResourceId

Ergonomic alias for Self::add_interrupt.

pub fn add_mmio_vmo( &mut self, name: impl Into<String>, vmo: &Vmo, offset: usize, logical_size: u64, ) -> Result<ResourceId, Status>

Shares an existing driver MMIO VMO with the embedded server using a default read/poll-permissive ceiling.

Duplicates vmo (zx::Rights::SAME_RIGHTS) and creates an independent local mapping in the driver host address space.

pub fn add_mmio_vmo_with_ceiling( &mut self, name: impl Into<String>, vmo: &Vmo, offset: usize, logical_size: u64, ceiling: ResourceCeiling, ) -> Result<ResourceId, Status>

Shares an existing driver MMIO VMO with an explicit ResourceCeiling (such as hard_denied ranges for clear-on-read/FIFO registers and writable_registers for permitted mutations).

pub fn add_mapped_mmio( &mut self, name: impl Into<String>, mmio: MappedMmio, logical_size: u64, ceiling: ResourceCeiling, ) -> ResourceId

Registers a pre-mapped MappedMmio region with an explicit ResourceCeiling.

pub fn with_state_bank( &mut self, name: impl Into<String>, bank: StateBank, ) -> ResourceId

Registers an in-memory StateBank exposing software state slots, runtime knobs, read probes, and diagnostic triggers with a ResourceCeiling populated from bank.writable_offsets().

pub fn add_state_bank( &mut self, name: impl Into<String>, bank: StateBank, ) -> ResourceId

Registers an in-memory StateBank using its configured writable offsets ceiling.

pub fn add_state_bank_with_ceiling( &mut self, name: impl Into<String>, bank: StateBank, ceiling: ResourceCeiling, ) -> ResourceId

Registers an in-memory StateBank with an explicit ResourceCeiling.

pub fn set_writable_registers( &mut self, resource_id: ResourceId, writable_registers: Vec<WritableRegister>, )

Configures the permitted 32-bit writable registers on an existing MMIO resource’s target ceiling.

pub fn set_hard_denied_ranges( &mut self, resource_id: ResourceId, ranges: Vec<Range<u64>>, )

Configures the hard-denied byte offset ranges on an existing MMIO resource’s target ceiling.

pub fn add_gpio( &mut self, name: impl Into<String>, proxy: GpioSynchronousProxy, ) -> ResourceId

Registers a GPIO protocol resource.

pub fn add_i2c( &mut self, name: impl Into<String>, proxy: DeviceSynchronousProxy, ) -> ResourceId

Registers an I2C protocol resource.

pub fn add_spi( &mut self, name: impl Into<String>, proxy: DeviceSynchronousProxy, ) -> ResourceId

Registers a SPI protocol resource.

pub fn add_clock( &mut self, name: impl Into<String>, proxy: ClockSynchronousProxy, ) -> ResourceId

Registers a Clock protocol resource.

pub fn add_reset( &mut self, name: impl Into<String>, proxy: ResetSynchronousProxy, ) -> ResourceId

Registers a Reset protocol resource.

pub fn add_serial( &mut self, name: impl Into<String>, proxy: DeviceSynchronousProxy, ) -> ResourceId

Registers a Serial protocol resource.

pub fn add_interrupt(&mut self, name: impl Into<String>) -> ResourceId

Registers an interrupt observation resource for event tapping.

pub fn build(self) -> Result<EmbeddedLabServer, ProviderError>

Validates all registered resources and builds the EmbeddedLabServer.