Struct ProjectPin 

#[non_exhaustive]
pub struct ProjectPin {
    pub schema_version: u32,
    pub palace: String,
    pub note: Option<String>,
}

Serialisable schema for .trusty-tools/trusty-memory.yaml.

Why: the pin is the committed, human-authored answer to “which palace is this project’s”, so it needs a typed schema rather than ad-hoc string scraping — a field that silently deserialises to the wrong type would redirect a project’s memory. What: schema_version (always PIN_SCHEMA_VERSION), palace (the pinned slug, stored verbatim and never re-slugified), and an optional human note. Test: reads_a_valid_pin, plus trusty-memory’s write_and_read_pin_round_trips.

#[non_exhaustive] because a future schema field must not be a breaking change for the crates.io consumers of this crate. That closes struct-literal construction outside trusty-common, so build one through Self::new.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema_version: u32

Pin-file format version.

palace: String

The pinned palace slug — verbatim, never re-slugified.

note: Option<String>

Optional human note (e.g. “pinned before drive reorg 2026-06”).

Implementations

impl ProjectPin

pub fn new(palace: impl Into<String>) -> ProjectPin

A pin naming palace, at the current PIN_SCHEMA_VERSION, with no note.

Why: ProjectPin is #[non_exhaustive], so no other crate can write the struct literal. Stamping the version here also stops a caller pinning an older one by copying an old literal. What: the two required fields; chain Self::with_note to add the note. Test: new_stamps_the_current_schema_version.

pub fn with_note(self, note: Option<String>) -> ProjectPin

Attach the optional human note. Test: with_note_round_trips_through_yaml.

Trait Implementations

impl Clone for ProjectPin

fn clone(&self) -> ProjectPin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectPin

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProjectPin

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProjectPin, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ProjectPin

impl PartialEq for ProjectPin

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProjectPin

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProjectPin