pub struct PulseDecodeWriter<W> { /* private fields */ }Expand description
Provides a decoder of TAPE T-state pulse intervals.
The timing of the pulses should match those produced by ZX Spectrum’s ROM loading routines.
After invoking PulseDecodeWriter::end or PulseDecodeWriter::new PulseDecodeWriter expects a data transfer which consists of:
- lead pulses followed by
 - two synchronization pulses followed by
 - data pulses
 
Provide pulse iterators to PulseDecodeWriter::write_decoded_pulses method to write interpreted data to the underlying writer.
Best used with tap utilities.
Implementations§
Source§impl<W> PulseDecodeWriter<W>
 
impl<W> PulseDecodeWriter<W>
Sourcepub fn reset(&mut self)
 
pub fn reset(&mut self)
Resets the state of the PulseDecodeWriter to Idle, discarding any partially received byte.
The information about the number of bytes written so far is lost.
Sourcepub fn is_idle(&self) -> bool
 
pub fn is_idle(&self) -> bool
Returns true if the state is PulseDecodeState::Idle.
Sourcepub fn into_inner(self) -> W
 
pub fn into_inner(self) -> W
Returns the underlying writer.
Sourcepub fn state(&self) -> PulseDecodeState
 
pub fn state(&self) -> PulseDecodeState
Returns a reference to the current state.
Sourcepub fn data_size(&self) -> Option<NonZeroU32>
 
pub fn data_size(&self) -> Option<NonZeroU32>
Returns a number of bytes written during current data transfer if a data transfer is in progress.
Sourcepub fn with_state(self, state: PulseDecodeState) -> Self
 
pub fn with_state(self, state: PulseDecodeState) -> Self
Allows to manually assign state.
Can be used to deserialize PulseDecodeWriter.
Source§impl<W: Write> PulseDecodeWriter<W>
 
impl<W: Write> PulseDecodeWriter<W>
Sourcepub fn end(&mut self) -> Result<Option<NonZeroU32>>
 
pub fn end(&mut self) -> Result<Option<NonZeroU32>>
Optionally writes a partially received data byte and ensures the state of PulseDecodeWriter is Idle.
After calling this method, regardless of the return value, the state is changed to PulseDecodeState::Idle.
Returns Ok(None) if there was no data written in the current transfer.
Returns Ok(Some(size)) if data has been written, providing the number of written bytes.
In the case of std::io::Error the information about the number of bytes written is lost.
Sourcepub fn write_decoded_pulses<I>(&mut self, iter: I) -> Result<Option<NonZeroU32>>where
    I: Iterator<Item = NonZeroU32>,
 
pub fn write_decoded_pulses<I>(&mut self, iter: I) -> Result<Option<NonZeroU32>>where
    I: Iterator<Item = NonZeroU32>,
Interprets pulse intervals from the provided pulse iterator as data bytes, writing them to the underlying writer.
The pulse iterator is expected to provide only a fragment of pulses needed for the complete transfer such as an iterator returned from MicOut::mic_out_pulse_iter. Providing an empty iterator is equivalent to calling PulseDecodeWriter::end thus ending the current transfer in progress if there is any.
Returns Ok(None) if there was no data or more pulses are being expected.
Returns Ok(Some(size)) if data block has been written, providing the number of written bytes.
In this instance, there can still be some pulses left in the iterator, e.g. for the next
incoming transfer.
In the case of std::io::Error the information about the number of bytes written is lost.
Trait Implementations§
Auto Trait Implementations§
impl<W> Freeze for PulseDecodeWriter<W>where
    W: Freeze,
impl<W> RefUnwindSafe for PulseDecodeWriter<W>where
    W: RefUnwindSafe,
impl<W> Send for PulseDecodeWriter<W>where
    W: Send,
impl<W> Sync for PulseDecodeWriter<W>where
    W: Sync,
impl<W> Unpin for PulseDecodeWriter<W>where
    W: Unpin,
impl<W> UnwindSafe for PulseDecodeWriter<W>where
    W: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
 
impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
 
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
 
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
    Self: Binary,
 
fn fmt_binary(self) -> FmtBinary<Self>where
    Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
    Self: Display,
 
fn fmt_display(self) -> FmtDisplay<Self>where
    Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
    Self: LowerExp,
 
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
    Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
    Self: LowerHex,
 
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
    Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
    Self: Octal,
 
fn fmt_octal(self) -> FmtOctal<Self>where
    Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
    Self: Pointer,
 
fn fmt_pointer(self) -> FmtPointer<Self>where
    Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
    Self: UpperExp,
 
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
    Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
    Self: UpperHex,
 
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
    Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<S, T> IntoSample<S> for Twhere
    S: FromSample<T>,
 
impl<S, T> IntoSample<S> for Twhere
    S: FromSample<T>,
Source§fn into_sample(self) -> S
 
fn into_sample(self) -> S
S a sample type from self.Source§impl<T> Pipe for Twhere
    T: ?Sized,
 
impl<T> Pipe for Twhere
    T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
    Self: Sized,
 
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
    Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
    R: 'a,
 
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
    R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
    R: 'a,
 
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
    R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
 
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
    &'a mut self,
    func: impl FnOnce(&'a mut B) -> R,
) -> R
 
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
 
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
 
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
 
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Tap for T
 
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
 
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
 
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
 
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
 
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
 
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
 
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
 
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
 
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
 
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
 
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
 
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
 
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
 
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.