Struct Manifest 

pub struct Manifest {
    pub schema_version: u32,
    pub canon_version: CanonVersion,
    pub canon_source: String,
    pub profile: ProfileId,
    pub docs_root: DocsRoot,
    pub installed_at: String,
    pub plan_zone: PlanZone,
    pub docs_scratch: Option<Utf8PathBuf>,
    pub managed_files: Vec<ManagedEntry>,
    pub adopted_files: Vec<AdoptedEntry>,
    pub integration_blocks: Vec<IntegrationBlock>,
}

Everything an instance records about itself.

Fields

schema_version: u32

Always SCHEMA_VERSION once parsed.

canon_version: CanonVersion

The canon release that produced the installed payload.

canon_source: String

Where that canon is published.

profile: ProfileId

The profile the instance was installed with.

docs_root: DocsRoot

The documentation root the gates read.

installed_at: String

When the instance was first installed; preserved across reinstalls.

plan_zone: PlanZone

Where the planning tool writes entry documents.

docs_scratch: Option<Utf8PathBuf>

Where material that is not a statement yet is kept.

managed_files: Vec<ManagedEntry>

Byte projections the canon keeps owning.

adopted_files: Vec<AdoptedEntry>

Files the instance owns against a recorded baseline.

integration_blocks: Vec<IntegrationBlock>

Marked regions the canon owns inside project files.

Implementations

impl Manifest

pub fn parse(json: &str) -> Result<Self, ManifestParseError>

Parse and validate a serialized manifest.

Errors

ManifestParseError::Older / ManifestParseError::Newer when the recorded schema version is not SCHEMA_VERSION, and ManifestParseError::Invalid for anything that does not fit the schema or records no managed file.

pub fn to_json(&self) -> String

Serialize in the canonical on-disk form: two-space indent, trailing newline.

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Manifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Manifest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Manifest

impl PartialEq for Manifest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Manifest

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 Manifest