Struct ContractView 

pub struct ContractView {

    pub id: String,
    pub path: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub status: String,
    pub scope: String,
    pub composition: String,
    pub order: i64,
    pub providers: Vec<String>,
    pub audience: Vec<String>,
    pub tracks: Vec<String>,
    pub children_require_contract: Option<bool>,
    pub children_exempt: Vec<String>,
}

A directory contract as the document declares it, before anything is inherited.

Fields

id: String

The document’s identity; it survives a move, the file name does not.

path: String

The document’s path, repository-relative.

title: Option<String>

One line naming the directory.

description: Option<String>

One line saying what the directory is for.

status: String

active or deprecated; a deprecated document is listed and never applied.

scope: String

directory, subtree or explicit: how far the document reaches.

composition: String

extend, replace or final: how it composes with what is above it.

order: i64

Ties within one depth are broken by this, then by path.

providers: Vec<String>

*, or the providers the document is written for.

audience: Vec<String>

Who it addresses; both when it says nothing.

tracks: Vec<String>

Pathspecs whose change names this document for review.

children_require_contract: Option<bool>

Whether the directories below owe a contract, when this document says.

children_exempt: Vec<String>

Subtrees below this one that owe nothing: carried, not authored here.

Trait Implementations

impl Clone for ContractView

fn clone(&self) -> ContractView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractView

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContractView

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ContractView

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ContractView

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

where __S: Serializer,

Serialize this value into the given Serde serializer.