Struct ProjectFile 

pub struct ProjectFile {
    pub metadata: OsMetadata,
    pub settings: Settings,
    pub states: State,
    pub slots: Slots<Option<SlotAttributes>>,
}

A parsed representation of an Octatrack Project file (project.work or project.strd).

Note: We derive serde::Deserialize and serde::Serialize on this (and all the included subtypes). But project files are actually string data being parsed directly without any serde-ing or bincode-ing. This may change in the future to custom Serialize/Deserialize implementations for string source file data. But that will only happen if i can work out how to differentiate between deserializing a yaml/json string and a raw data file’s string data (we use serde::de::Deserializer::is_human_readable for arrangements to differentiate between YAML/JSON and string data files, which is a problem here as we’ll be testing for the difference between YAML/JSON (string data) and String (string data).)

No Copy trait as neither OsMetadata nor SlotAttributes support the Copy trait

Fields

metadata: OsMetadata

Metadata key-value pairs from a Project file.

settings: Settings

Settings key-value pairs from a Project file.

states: State

States key-value pairs from a Project file.

slots: Slots<Option<SlotAttributes>>

Slots key-value pairs from a Project file.

Implementations

impl ProjectFile

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

Check to see if the ProjectFile has a valid OS version for the current version of this library. The OS version string is contained in the project.* file under the x.metadata.os_version field. Multiple OS versions could be supported at any one time.

let proj = ProjectFile::from_data_file(&path).unwrap();
assert!(proj.check_compatible_os_version().unwrap());

Trait Implementations

impl AsMut<ProjectFile> for ProjectFile

fn as_mut(&mut self) -> &mut ProjectFile

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<ProjectFile> for ProjectFile

fn as_ref(&self) -> &ProjectFile

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ProjectFile

fn clone(&self) -> ProjectFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectFile

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

Formats the value using the given formatter.

impl Default for ProjectFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProjectFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProjectFile

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

Formats the value using the given formatter.

impl Eq for ProjectFile

impl HasChecksumField for ProjectFile

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

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

fn update_checksum(&mut self) -> Result<(), OtToolsIoError>

Method for updating 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 ProjectFile

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 ProjectFile

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

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

impl Hash for ProjectFile

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IsDefault for ProjectFile

fn is_default(&self) -> bool

where Self: Default + PartialEq,

impl OctatrackFileIO for ProjectFile

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

Read type from bytes

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

Create bytes from type

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 to_data_file(&self, path: &Path) -> Result<(), OtToolsIoError>

Write type to an Octatrack data file at path

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

impl Ord for ProjectFile

fn cmp(&self, other: &ProjectFile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ProjectFile

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ProjectFile

fn partial_cmp(&self, other: &ProjectFile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ProjectFile

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 ProjectFile