Struct Manifest 

pub struct Manifest {
    pub spec: String,
    pub spec_version: SpecVersion,
    pub capabilities: Option<Capabilities>,
    pub manifest: ManifestMeta,
    pub ports: Vec<Port>,
}

Canonical manifest representation.

Fields

spec: String

Identifier for this specification (must be fio).

spec_version: SpecVersion

capabilities: Option<Capabilities>

Optional conformance capabilities for this manifest.

manifest: ManifestMeta

Human-facing metadata describing the manifest.

ports: Vec<Port>

Ordered list of typed ports.

Implementations

impl Manifest

pub fn from_yaml_reader<R: Read>(reader: R) -> Result<Self, Error>

Construct a manifest by reading YAML from any reader.

pub fn from_yaml_str(yaml: &str) -> Result<Self, Error>

Construct a manifest from a YAML string slice.

pub fn to_yaml(&self) -> Result<String, Error>

Serialize this manifest to YAML.

pub fn normalize(&mut self)

Normalize the manifest in-place for deterministic comparison.

• Ports are sorted lexicographically by id.
• Tags (if any) are sorted and deduplicated.
• Table keys (if any) are sorted and deduplicated.
• Enumerated constraint values are sorted and deduplicated.

pub fn normalized(self) -> Self

Return a normalized copy of the manifest.

pub fn effective_profile(&self) -> Profile

Return the effective conformance profile for this manifest.

When capabilities are omitted, the manifest is treated as core-v0.

pub fn validate(&self) -> Result<(), ValidationError>

Validate the manifest and return granular issues when invariants fail.

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 FromStr for Manifest

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl JsonSchema for Manifest

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 Manifest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.