Struct spectrusty_core::bus::DynamicSerdeBus

#[repr(transparent)]pub struct DynamicSerdeBus<S, D: BusDevice>(_, _);

A wrapper for DynamicBus that is able to serialize and deserialize together with currently attached dynamic devices.

Use this type instead of DynamicBus when specifying crate::chip::ControlUnit::BusDevice or BusDevice::NextDevice.

A type that implements SerializeDynDevice and DeserializeDynDevice must be declared as generic parameter S.

Methods from Deref<Target = DynamicBus<D>>

pub fn len(&self) -> usize

Returns the number of attached devices.

pub fn is_empty(&self) -> bool

Returns true if there are no devices in the dynamic chain. Otherwise returns false.

pub fn append_device<B>(&mut self, device: B) -> usize where
    B: Into<BoxNamedDynDevice<D::Timestamp>>, 

Appends an instance of a device at the end of the daisy-chain. Returns its index position in the dynamic device chain.

pub fn remove_device(&mut self) -> Option<BoxNamedDynDevice<D::Timestamp>>

Removes the last device from the dynamic daisy-chain and returns an instance of the boxed dynamic object.

pub fn swap_remove_device(
    &mut self,
    index: usize
) -> BoxNamedDynDevice<D::Timestamp>

Replaces a device at the given index position and returns it.

The removed device is replaced by the last device of the chain.

Panics

Panics if a device doesn't exist at index.

pub fn replace_device<B>(
    &mut self,
    index: usize,
    device: B
) -> BoxNamedDynDevice<D::Timestamp> where
    B: Into<BoxNamedDynDevice<D::Timestamp>>, 

Replaces a device at the given index position. Returns the previous device occupying the replaced spot.

Panics

Panics if a device doesn't exist at index.

pub fn clear(&mut self)

Removes all dynamic devices from the dynamic daisy-chain.

pub fn get_device_ref(
    &self,
    index: usize
) -> Option<&NamedDynDevice<D::Timestamp>>

Returns a reference to a dynamic device at index position in the dynamic daisy-chain.

pub fn get_device_mut(
    &mut self,
    index: usize
) -> Option<&mut NamedDynDevice<D::Timestamp>>

Returns a mutable reference to a dynamic device at index position in the dynamic daisy-chain.

pub fn remove_as_device<B>(&mut self) -> Option<Box<B>> where
    B: NamedBusDevice<D::Timestamp> + 'static, 

Removes the last device from the dynamic daisy-chain.

Panics

Panics if a device is not of a type given as parameter B.

pub fn swap_remove_as_device<B>(&mut self, index: usize) -> Box<B> where
    B: NamedBusDevice<D::Timestamp> + 'static, 

Replaces a device at the given index and returns it.

The removed device is replaced by the last device of the chain.

Panics

Panics if a device doesn't exist at index or if a device is not of a type given as parameter B.

pub fn as_device_ref<B>(&self, index: usize) -> &B where
    B: NamedBusDevice<D::Timestamp> + 'static, 

Returns a reference to a device of a type B at index in the dynamic daisy-chain.

Panics

Panics if a device doesn't exist at index or if a device is not of a type given as parameter B.

pub fn as_device_mut<B>(&mut self, index: usize) -> &mut B where
    B: NamedBusDevice<D::Timestamp> + 'static, 

Returns a mutable reference to a device of a type B at index in the dynamic daisy-chain.

Panics

Panics if a device doesn't exist at index or if a device is not of a type given as parameter B.

pub fn is_device<B>(&self, index: usize) -> bool where
    B: NamedBusDevice<D::Timestamp> + 'static, 

Returns true if a device at index is of a type given as parameter B.

pub fn position_device<B>(&self) -> Option<usize> where
    B: NamedBusDevice<D::Timestamp> + 'static, 

Searches for a first device of a type given as parameter B, returning its index.

pub fn find_device_ref<B>(&self) -> Option<&B> where
    B: NamedBusDevice<D::Timestamp> + 'static, 

Searches for a first device of a type given as parameter B, returning a reference to a device.

pub fn find_device_mut<B>(&mut self) -> Option<&mut B> where
    B: NamedBusDevice<D::Timestamp> + 'static, 

Searches for a first device of a type given as parameter B, returning a mutable reference to a device.

Trait Implementations

impl<S, D: BusDevice> BusDevice for DynamicSerdeBus<S, D> where
    D: BusDevice,
    D::Timestamp: Copy + Debug, 

type Timestamp = D::Timestamp

A type used as a time-stamp.

type NextDevice = D

A type of the next device in a daisy chain.

pub fn next_device_mut(&mut self) -> &mut Self::NextDevice

Returns a mutable reference to the next device.

pub fn next_device_ref(&self) -> &Self::NextDevice

Returns a reference to the next device.

pub fn into_next_device(self) -> Self::NextDevice

Destructs self and returns the instance of the next bus device.

pub fn reset(&mut self, timestamp: Self::Timestamp)

Resets the device and all devices in this chain.

pub fn update_timestamp(&mut self, timestamp: Self::Timestamp)

This method should be called near the end of each frame.

pub fn next_frame(&mut self, timestamp: Self::Timestamp)

This method should be called just before the T-state counter of the control unit is wrapped when preparing for the next frame.

pub fn read_io(
    &mut self,
    port: u16,
    timestamp: Self::Timestamp
) -> Option<(u8, Option<NonZeroU16>)>

This method is called by the control unit during an I/O read cycle.

pub fn write_io(
    &mut self,
    port: u16,
    data: u8,
    timestamp: Self::Timestamp
) -> Option<u16>

This method is called by the control unit during an I/O write cycle.

pub fn type_id(&self) -> TypeId where
    Self: 'static, 

Gets the TypeId of self.

impl<S, D> Debug for DynamicSerdeBus<S, D> where
    D: BusDevice + Debug,
    D::Timestamp: Debug, 

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S, D> Default for DynamicSerdeBus<S, D> where
    D: BusDevice + Default,
    D::Timestamp: Default, 

pub fn default() -> Self

Returns the "default value" for a type.

impl<S, D: BusDevice> Deref for DynamicSerdeBus<S, D>

type Target = DynamicBus<D>

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S, D: BusDevice> DerefMut for DynamicSerdeBus<S, D>

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, DDD, B> Deserialize<'de> for DynamicSerdeBus<DDD, B> where
    DDD: DeserializeDynDevice<'de> + 'de,
    B: BusDevice + Deserialize<'de> + Default,
    B::Timestamp: Default + TimestampOps + Deserialize<'de> + 'static, 

pub fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<S, D: BusDevice> From<DynamicBus<D>> for DynamicSerdeBus<S, D>

pub fn from(dynamic_bus: DynamicBus<D>) -> Self

Performs the conversion.

impl<S, D: BusDevice> From<DynamicSerdeBus<S, D>> for DynamicBus<D>

pub fn from(dynamic_bus: DynamicSerdeBus<S, D>) -> Self

Performs the conversion.

impl<SDD, B> Serialize for DynamicSerdeBus<SDD, B> where
    SDD: SerializeDynDevice,
    B: BusDevice + Serialize,
    B::Timestamp: TimestampOps + Serialize + 'static, 

pub fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.