Struct PinHeader 

pub struct PinHeader {
    pub v: u32,
    pub model: String,
    pub model_hash: Option<String>,
    pub source_hash: String,
    pub vec_hash: String,
    pub vec_dtype: String,
    pub vec_dim: u32,
    pub ts: String,
    pub extra: BTreeMap<String, String>,
}

The signed portion of a Pin.

Two pins are considered equivalent iff their headers canonicalize to identical bytes. Optional fields (model_hash, extra) are omitted from the canonical form when unset, never written as null — this matters because adding a null would change the byte sequence the signature commits to.

You normally do not construct PinHeader directly; obtain one from Signer::pin or Signer::pin_with_options.

Fields

v: u32

Protocol version. Must equal PROTOCOL_VERSION.

model: String

Embedding model identifier.

model_hash: Option<String>

Optional content hash of the model weights.

source_hash: String

SHA-256 of the source text (UTF-8 NFC).

vec_hash: String

SHA-256 of the embedding vector under the declared dtype.

vec_dtype: String

"f32" or "f64".

vec_dim: u32

Embedding dimensionality.

ts: String

RFC 3339 / ISO 8601 timestamp in UTC, e.g. "2026-05-05T12:00:00Z".

extra: BTreeMap<String, String>

Producer-defined string-to-string metadata, signed alongside the rest of the header. Omitted from the canonical form when empty.

Implementations

impl PinHeader

pub fn canonicalize(&self) -> Vec<u8>

Stable byte representation for signing/verifying.

JSON with sorted keys and no whitespace. BTreeMap gives us sorted extra for free; field order is fixed by hand below to match the Python reference.

Trait Implementations

impl Clone for PinHeader

fn clone(&self) -> PinHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PinHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PinHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PinHeader

fn eq(&self, other: &PinHeader) -> 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 PinHeader

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PinHeader

impl StructuralPartialEq for PinHeader