Struct ArtifactHeader 

pub struct ArtifactHeader {
    pub version: u16,
    pub generation_label: String,
    pub source: String,
    pub endian_policy: EndianPolicy,
    pub profile: ArtifactProfile,
}

Describes the non-body metadata stored in a compressed artifact.

Fields

version: u16

Format version.

generation_label: String

Human-readable generation label.

source: String

Human-readable provenance/source summary.

endian_policy: EndianPolicy

Explicit byte-order policy for the stored numeric fields.

profile: ArtifactProfile

Artifact capability profile describing stored, derived, and unsupported outputs.

Implementations

impl ArtifactHeader

pub fn new( generation_label: impl Into<String>, source: impl Into<String>, ) -> Self

Creates a new header using the current artifact version, an explicit little-endian byte-order policy, and a conservative profile that stores only ecliptic longitude/latitude/distance channels (with equatorial coordinates and motion derived, and apparent/topocentric/sidereal outputs unsupported).

pub fn with_profile( generation_label: impl Into<String>, source: impl Into<String>, profile: ArtifactProfile, ) -> Self

Creates a new header using the current artifact version, an explicit little-endian byte-order policy, and an explicit profile.

pub fn with_profile_and_endian( generation_label: impl Into<String>, source: impl Into<String>, endian_policy: EndianPolicy, profile: ArtifactProfile, ) -> Self

Creates a new header with an explicit byte-order policy and profile.

pub fn summary(&self) -> String

Returns a compact one-line summary of the byte order and capability profile encoded by this header.

pub fn summary_line(&self) -> String

Returns a compact one-line summary of the byte order and capability profile encoded by this header.

pub fn validate(&self) -> Result<(), CompressionError>

Validates that the header’s version and provenance fields are populated with canonical, non-whitespace-padded text.

The codec already enforces these checks at encode/decode time, but exposing the validation step directly lets artifact generators and release tooling fail before writing or reusing an invalid header.

pub fn summary_for_body_count(&self, body_count: usize) -> String

Returns the header summary annotated with how many bodies share it.

Trait Implementations

impl Clone for ArtifactHeader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArtifactHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArtifactHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ArtifactHeader

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

Formats the value using the given formatter.

impl Eq for ArtifactHeader

impl PartialEq for ArtifactHeader

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ArtifactHeader

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 ArtifactHeader