Struct a2kit::fs::cpm::Disk

pub struct Disk { /* private fields */ }

The primary interface for disk operations. The “Disk Parameter Block” that is provided upon creation is in correspondence with what would be stored in BIOS.

Implementations

impl Disk

pub fn from_img( img: Box<dyn DiskImage>, dpb: DiskParameterBlock, cpm_vers: [u8; 3] ) -> Self

Create a disk file system using the given image as storage. The DiskFS takes ownership of the image and DPB.

pub fn test_img( img: &mut Box<dyn DiskImage>, dpb: &DiskParameterBlock, cpm_vers: [u8; 3] ) -> bool

Test an image for the CP/M file system.

pub fn format( &mut self, vol_name: &str, _time: Option<NaiveDateTime> ) -> Result<(), Box<dyn Error>>

Format disk for the CP/M file system. The time argument is currently ignored, because we are not using the disk label extent.

Trait Implementations

impl DiskFS for Disk

fn new_fimg(&self, chunk_len: usize) -> FileImage

Create an empty file image appropriate for this file system

fn catalog_to_stdout(&mut self, _path: &str) -> Result<(), Box<dyn Error>>

List all the files on disk to standard output, mirrors CATALOG

fn create(&mut self, _path: &str) -> Result<(), Box<dyn Error>>

Create a new directory

fn delete(&mut self, xname: &str) -> Result<(), Box<dyn Error>>

Delete a file or directory

fn lock(&mut self, xname: &str) -> Result<(), Box<dyn Error>>

write protect a file

fn unlock(&mut self, xname: &str) -> Result<(), Box<dyn Error>>

fn rename( &mut self, old_xname: &str, new_xname: &str ) -> Result<(), Box<dyn Error>>

Rename a file or directory

fn retype( &mut self, xname: &str, new_type: &str, _sub_type: &str ) -> Result<(), Box<dyn Error>>

Change the type and subtype of a file, strings may contain numbers as appropriate.

fn bload(&mut self, xname: &str) -> Result<(u16, Vec<u8>), Box<dyn Error>>

Read a binary file from the disk, mirrors BLOAD. Returns (aux,data), aux = starting address.

fn bsave( &mut self, xname: &str, dat: &[u8], _start_addr: u16, trailing: Option<&[u8]> ) -> Result<usize, Box<dyn Error>>

Write a binary file to the disk, mirrors BSAVE

fn load(&mut self, _name: &str) -> Result<(u16, Vec<u8>), Box<dyn Error>>

Read a BASIC program file from the disk, mirrors LOAD, program is in tokenized form. Detokenization is handled in a different module. Returns (aux,data), aux = 0

fn save( &mut self, _name: &str, _dat: &[u8], _typ: ItemType, _trailing: Option<&[u8]> ) -> Result<usize, Box<dyn Error>>

Write a BASIC program to the disk, mirrors SAVE, program must already be tokenized. Tokenization is handled in a different module.

fn read_text(&mut self, xname: &str) -> Result<(u16, Vec<u8>), Box<dyn Error>>

Read sequential text file from the disk, mirrors READ, text remains in raw A2 format. Use decode_text to get a UTF8 string. Returns (aux,data), aux = 0.

fn write_text( &mut self, xname: &str, dat: &[u8] ) -> Result<usize, Box<dyn Error>>

Write sequential text file to the disk, mirrors WRITE, text must already be in A2 format. Use encode_text to generate data from a UTF8 string.

fn read_records( &mut self, _name: &str, _record_length: usize ) -> Result<Records, Box<dyn Error>>

Read records from a random access text file. This finds all possible records, some may be spurious. The record_length can be set to 0 on file systems where this is stored with the file.

fn write_records( &mut self, _name: &str, _records: &Records ) -> Result<usize, Box<dyn Error>>

Write records to a random access text file

fn read_block(&mut self, num: &str) -> Result<(u16, Vec<u8>), Box<dyn Error>>

Get a native file system allocation unit

fn write_block( &mut self, num: &str, dat: &[u8] ) -> Result<usize, Box<dyn Error>>

Put a native file system allocation unit N.b. this simply zaps the block and can break the file system.

fn read_any(&mut self, xname: &str) -> Result<FileImage, Box<dyn Error>>

Read a file into a generalized representation

fn write_any( &mut self, xname: &str, fimg: &FileImage ) -> Result<usize, Box<dyn Error>>

Write a file from a generalized representation

fn decode_text(&self, dat: &[u8]) -> Result<String, Box<dyn Error>>

Convert file system text to a UTF8 string

fn encode_text(&self, s: &str) -> Result<Vec<u8>, Box<dyn Error>>

Convert UTF8 string to file system text

fn standardize(&mut self, _ref_con: u16) -> HashMap<Block, Vec<usize>>

Standardize for comparison with other sources of disk images. Returns a map from blocks to offsets within the block that are to be zeroed or ignored. Typically it is important to call this before deletions happen. May be recursive, ref_con can be used to initialize each recursion.

fn compare(&mut self, path: &Path, ignore: &HashMap<Block, Vec<usize>>)

Compare this disk with a reference disk for testing purposes. Panics if comparison fails.

fn get_img(&mut self) -> &mut Box<dyn DiskImage>

Mutably borrow the underlying disk image