Struct Header 

pub struct Header {
    pub format_version: i32,
    /* private fields */
}

The header struct represents the header of a DMX file.

Fields

format_version: i32

The version of the format.

Implementations

impl Header

pub fn new(format: impl Into<String>, format_version: i32) -> Self

Creates a new header with the given format and format version. The format is truncated to 64 characters.

pub fn set_format(&mut self, format: impl Into<String>)

Sets the format of the header. The format is truncated to 64 characters.

pub fn get_format(&self) -> &str

Returns the format of the header.

pub fn from_string( value: String, ) -> Result<(Self, String, i32), FileHeaderError>

Returns a header from a string.

pub fn from_buffer( buffer: &mut impl BufRead, ) -> Result<(Self, String, i32), FileHeaderError>

Reads a header from a buffer.

pub fn create_header(&self, encoding: &str, encoding_version: i32) -> String

Creates a dmx header string.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.