SceneHeader

Struct SceneHeader 

Source
pub struct SceneHeader {
    pub magic_bytes: [u8; 8],
    pub format_version: u8,
    pub strategy_id: [u8; 32],
    pub payload_length: u64,
}
Expand description

The fixed-size header at the beginning of every Khora scene file.

Fields§

§magic_bytes: [u8; 8]

Magic bytes to identify the file type, must be HEADER_MAGIC_BYTES.

§format_version: u8

The version of the header format itself.

§strategy_id: [u8; 32]

A null-padded UTF-8 string identifying the serialization strategy used. e.g., “KH_RECIPE_V1”, “KH_ARCHETYPE_V1”.

§payload_length: u64

The length of the payload data that follows this header, in bytes.

Implementations§

Source§

impl SceneHeader

Source

pub const SIZE: usize = 49usize

The total size of the header in bytes.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, &'static str>

Attempts to parse a SceneHeader from the beginning of a byte slice.

Source

pub fn to_bytes(&self) -> [u8; 49]

Serializes the header into a fixed-size byte array.

Trait Implementations§

Source§

impl Clone for SceneHeader

Source§

fn clone(&self) -> SceneHeader

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SceneHeader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SceneHeader

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for SceneHeader

Source§

impl StructuralPartialEq for SceneHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.