Struct spectrusty::peripherals::storage::microdrives::MicroCartridge

pub struct MicroCartridge { /* fields omitted */ }

This struct represents an emulated Microdrive tape cartridge.

It consist of up to MAX_SECTORS Sectors. Instances of this struct can be "inserted" into one of 8 ZxMicrodrives's emulator drives.

Implementations

impl MicroCartridge

pub fn head_at(&self) -> f32

Returns the current drive's head position counted in sectors as floating point value.

The fractional part indicates how far the head position is within a sector.

pub fn max_sectors(&self) -> usize

Returns the number of the emulated physical sectors on the tape.

pub fn count_formatted(&self) -> usize

Returns the number of formatted sectors.

pub fn iter_with_indices(
    &self
) -> FilterMap<Enumerate<Zip<Iter<'_, Sector>, Iter<'_, Lsb0, u32>>>, &dyn Fn((usize, (&Sector, BitRef<'_, Const, Lsb0, u32>)))>

Returns an iterator of formatted sectors with their original indices.

pub fn is_write_protected(&self) -> bool

Returns true if the cartridge is write protected.

pub fn set_write_protected(&mut self, protect: bool)

Changes the write protected flag of the cartridge.

pub fn is_sector_formatted(&self, sector: u8) -> bool

Returns true if the given sector is formatted.

Panics

Panics if sector equals to or is above the max_sectors limit.

pub fn new_with_sectors<S>(
    sectors: S,
    write_protect: bool,
    max_sectors: usize
) -> MicroCartridge where
    S: Into<Vec<Sector, Global>>, 

Creates a new instance of MicroCartridge with provided sectors.

Note

Content of the sectors is not verified and is assumed to be properly formatted.

Panics

The number of sectors provided must not be greater than MAX_USABLE_SECTORS. max_sectors must not be 0 and must be grater or equal to the number of provided sectors and must not be greater than MAX_SECTORS.

pub fn new(max_sectors: usize) -> MicroCartridge

Creates a new instance of MicroCartridge with custom max_sectors number.

Panics

max_sectors must not be 0 and must not be greater than MAX_SECTORS.

Trait Implementations

impl Clone for MicroCartridge

pub fn clone(&self) -> MicroCartridge

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MicroCartridge

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

Formats the value using the given formatter.

impl Default for MicroCartridge

pub fn default() -> MicroCartridge

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for MicroCartridge

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<MicroCartridge, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Index<u8> for MicroCartridge

type Output = Sector

The returned type after indexing.

pub fn index(&self, index: u8) -> &<MicroCartridge as Index<u8>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<u8> for MicroCartridge

pub fn index_mut(
    &mut self,
    index: u8
) -> &mut <MicroCartridge as Index<u8>>::Output

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a mut MicroCartridge

Iterates through formatted sectors.

type Item = &'a mut Sector

The type of the elements being iterated over.

type IntoIter = FilterMap<Zip<IterMut<'a, Sector>, Iter<'a, Lsb0, u32>>, &'a (dyn Fn((&'a mut Sector, BitRef<'a, Const, Lsb0, u32>)) + 'a)>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <&'a mut MicroCartridge as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a MicroCartridge

Iterates through formatted sectors.

type Item = &'a Sector

The type of the elements being iterated over.

type IntoIter = FilterMap<Zip<Iter<'a, Sector>, Iter<'a, Lsb0, u32>>, &'a (dyn Fn((&'a Sector, BitRef<'a, Const, Lsb0, u32>)) + 'a)>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <&'a MicroCartridge as IntoIterator>::IntoIter

Creates an iterator from a value.

impl MicroCartridgeExt for MicroCartridge

pub fn file_info<S>(
    &self,
    file_name: S
) -> Result<Option<CatFile>, MdrValidationError> where
    S: AsRef<[u8]>, 

Returns file meta data if the file with file_name exists.

pub fn file_type<S>(
    &self,
    file_name: S
) -> Result<Option<CatFileType>, MdrValidationError> where
    S: AsRef<[u8]>, 

Returns a file type if the file with file_name exists.

pub fn file_to_tap_writer<S, W>(
    &self,
    file_name: S,
    wr: &mut TapChunkWriter<W>
) -> Result<bool, Error> where
    S: AsRef<[u8]>,
    W: Write + Seek, 

Retrieves content of a binary file and writes it to a TAP chunk writer with a proper TAP header.

pub fn file_from_tap_reader<R>(
    &mut self,
    rd: &mut TapChunkReader<R>
) -> Result<u8, Error> where
    R: Read + Seek, 

Stores content read from a TAP chunk reader as a new file on a MicroCartridge. Returns the number of newly occupied sectors on success.

pub fn retrieve_file<S, W>(
    &self,
    file_name: S,
    wr: W
) -> Result<Option<(CatFileType, usize)>, Error> where
    S: AsRef<[u8]>,
    W: Write, 

Retrieves content of a file from a MicroCartridge and writes it to wr if the file with file_name exists. Returns the type and the size of the file on success.

pub fn store_file<S, R>(
    &mut self,
    file_name: S,
    is_save: bool,
    rd: R
) -> Result<u8, Error> where
    R: Read,
    S: AsRef<[u8]>, 

Stores content read from rd as a new file on a MicroCartridge. Returns the number of newly occupied sectors on success.

pub fn erase_file<S>(&mut self, file_name: S) -> u8 where
    S: AsRef<[u8]>, 

Marks all sectors (including copies and unclosed files) belonging to a provided file_name as free. Returns the number of erased sectors.

pub fn file_sector_ids_unordered<S>(
    &self,
    file_name: S
) -> FileSectorIdsUnordIter<'_> where
    S: AsRef<[u8]>, 

Returns an iterator of sector indices with unordered blocks of the provided file_name.

pub fn file_sectors<S>(&self, file_name: S) -> FileSectorIter<'_> where
    S: AsRef<[u8]>, 

Returns an iterator of sectors with ordered blocks belonging to the provided file_name.

pub fn catalog(&self) -> Result<Option<Catalog>, MdrValidationError>

Validates formatted sectors and returns a catalog of files.

pub fn catalog_name(&self) -> Result<Option<Cow<'_, str>>, MdrValidationError>

Validates formatted sectors and returns a catalog name if all formatted sectors contain the same header indicating a properly formatted cartridge.

pub fn validate_sectors(&self) -> Result<usize, MdrValidationError>

Checks if each formatted sector has flags property set and if all checksums are valid.

pub fn count_sectors_in_use(&self) -> usize

Returns the number of sectors being used by file data.

pub fn from_mdr<R>(rd: R, max_sectors: usize) -> Result<MicroCartridge, Error> where
    R: Read, 

Reads the content of an .mdr file into the MicroCartridge sectors.

pub fn write_mdr<W>(&self, wr: W) -> Result<usize, Error> where
    W: Write, 

Writes all formatted sectors to an .mdr file using a provided writer.

pub fn new_formatted<S>(max_sectors: usize, catalog_name: S) -> MicroCartridge where
    S: AsRef<[u8]>, 

Creates a new instance of MicroCartridge with formatted sectors.

impl Serialize for MicroCartridge

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.