Struct Declaration 

pub struct Declaration {
    pub canon_templates: Vec<String>,
    pub profiles: Vec<ProfileDeclaration>,
    pub managed: Vec<Projection>,
    pub adopted: Vec<Projection>,
    pub sentinels: Vec<SentinelDeclaration>,
}

Everything one release declares about what it lands.

Fields

canon_templates: Vec<String>

The template copies the canon keeps in its own documentation tree.

profiles: Vec<ProfileDeclaration>

Every profile the release offers.

managed: Vec<Projection>

Byte projections the canon keeps owning.

adopted: Vec<Projection>

Seeds the instance owns from the moment they land.

sentinels: Vec<SentinelDeclaration>

One sentinel per feature a project can declare.

Implementations

impl Declaration

pub fn parse(bytes: &[u8]) -> Result<Self, DeclarationError>

Read a declaration, refusing a schema this engine does not decode.

Errors

DeclarationError when the bytes do not parse or when the declaration contradicts itself.

pub fn profile(&self, id: ProfileId) -> Option<Profile<'_>>

What one profile lands, as this release declares it.

pub fn docs_root(&self, id: ProfileId) -> Option<DocsRoot>

The documentation root one profile takes, where it is declared.

Trait Implementations

impl Clone for Declaration

fn clone(&self) -> Declaration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Declaration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Declaration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Declaration

impl PartialEq for Declaration

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Declaration

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 Declaration