Struct BankFile 

pub struct BankFile {
    pub header: [u8; 21],
    pub datatype_version: u8,
    pub patterns: PatternArray,
    pub parts: Parts,
    pub parts_saved_state: [u8; 4],
    pub parts_edited_bitmask: u8,
    pub part_names: [[u8; 7]; 4],
    pub checksum: u16,
}

An Octatrack Bank. Contains data related to Parts and Patterns.

Fields

header: [u8; 21]

Misc header data for Banks. Always follows the same format.

datatype_version: u8

patterns: PatternArray

Pattern data for a Bank.

parts: Parts

All part data for this bank, includes currently unsaved and previously saved state

parts_saved_state: [u8; 4]

Indicates which parts have previously saved state available for reloading.

parts_edited_bitmask: u8

Bit mask indicating which parts are currently in an edited state.

parts
1 2 3 4 | mask
--------|------
- - - - | 0
x - - - | 1
- x - - | 2
- - x - | 4
- - - x | 8
--------|------
x x - - | 3
x - x - | 5
- x x - | 6
x x x - | 7
x - - x | 9
- x - x | 10
x x - x | 11
- - x x | 12
- x x x | 14
x x x x | 15

part_names: [[u8; 7]; 4]

Names for each Part within the Bank. Maximum 7 character length.

checksum: u16

checksum bytes

Trait Implementations

impl CheckFileIntegrity for BankFile

fn check_integrity(&self) -> Result<bool, OtToolsIoError>

impl Clone for BankFile

fn clone(&self) -> BankFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BankFile

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

Formats the value using the given formatter.

impl Default for BankFile

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Defaults<[BankFile; N]> for BankFile

fn defaults() -> [Self; N]

where Self: Default,

Create an default container type T containing N default instances of Self.

impl<const N: usize> Defaults<Box<Array<BankFile, N>>> for BankFile

fn defaults() -> Box<Array<Self, N>>

where Self: Defaults<[Self; N]>,

Create an default container type T containing N default instances of Self.

impl<'de> Deserialize<'de> for BankFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasChecksumField for BankFile

fn calculate_checksum(&self) -> Result<u16, OtToolsIoError>

Method for calculating the checksum value for types that have a checksum field

fn check_checksum(&self) -> Result<bool, OtToolsIoError>

Method to verify if checksum is valid in some data type. See this thread.

impl HasFileVersionField for BankFile

fn check_file_version(&self) -> Result<bool, OtToolsIoError>

Method to verify if the data file version field is valid for the given type.

impl HasHeaderField for BankFile

fn check_header(&self) -> Result<bool, OtToolsIoError>

Method to verify if header(s) are valid in some data. See this thread.

impl IsDefault for BankFile

fn is_default(&self) -> bool

where Self: Default + PartialEq,

impl OctatrackFileIO for BankFile

fn encode(&self) -> Result<Vec<u8>, OtToolsIoError>

where Self: Serialize,

Adds serialization via bincode and serde to a type. Must be present on all major file types.

fn repr(&self, newlines: Option<bool>)

where Self: Debug,

Read type from an Octatrack data file at path

fn from_data_file(path: &Path) -> Result<Self, OtToolsIoError>

Read type from an Octatrack data file at path

fn from_bytes(bytes: &[u8]) -> Result<Self, OtToolsIoError>

Read type from bytes

fn to_data_file(&self, path: &Path) -> Result<(), OtToolsIoError>

Write type to an Octatrack data file at path

fn to_bytes(&self) -> Result<Vec<u8>, OtToolsIoError>

Create bytes from type

fn from_yaml_file(path: &Path) -> Result<Self, OtToolsIoError>

Read type from a YAML file at path

fn from_yaml_str(yaml: &str) -> Result<Self, OtToolsIoError>

Read type from YAML string

fn to_yaml_file(&self, path: &Path) -> Result<(), OtToolsIoError>

Write type to a YAML file at path

fn to_yaml_string(&self) -> Result<String, OtToolsIoError>

Create YAML string from type

fn from_json_file(path: &Path) -> Result<Self, OtToolsIoError>

Read type from a JSON file at path

fn from_json_str(json: &str) -> Result<Self, OtToolsIoError>

Create type from JSON string

fn to_json_file(&self, path: &Path) -> Result<(), OtToolsIoError>

Write type to a JSON file at path

fn to_json_string(&self) -> Result<String, OtToolsIoError>

Create JSON string from type

fn decode(bytes: &[u8]) -> Result<Self, OtToolsIoError>

where Self: Sized + for<'a> Deserialize<'a>,

Deserialization via bincode and serde.

impl PartialEq for BankFile

fn eq(&self, other: &BankFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BankFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BankFile