Struct simics_package::spec::ManifestPackageSpec

pub struct ManifestPackageSpec {

    package_name: Option<String>,
    package_number: Option<isize>,
    name: Option<String>,
    description: Option<String>,
    host: Option<String>,
    version: Option<String>,
    build_id: Option<isize>,
    build_id_namespace: Option<String>,
    confidentiality: Option<String>,
    files: Vec<(String, String)>,
    typ: Option<String>,
    disabled: bool,
    doc_title: Option<String>,
    make_targets: Vec<String>,
    include_release_notes: bool,
    ip_plans: Vec<String>,
    legacy_doc_make_targets: Vec<String>,
    release_notes: Vec<String>,
    access_labels: Vec<String>,
}

A package specification deserialized from the

[package.metadata.simics]

field in Cargo.toml. This specification is used to generate the real specification, and many options left optional in the manifest are not optional to Simics. Sane defaults are provided for all options.

Fields

package_name: Option<String>

The one-word alphanumeric package name, e.g. ‘TSFFS-Fuzzer’ in Camel-Kebab-Case

package_number: Option<isize>

The package number. This is the only field that must be included in the crate metadata. It must be globally unique.

name: Option<String>

The human-readable name of the package e.g. ‘TSFFS Fuzzer’, the package name with dashes replaced with spaces.

description: Option<String>

A description of the package, e.g. ‘TSFFS: The Target Software Fuzzer for SIMICS’

host: Option<String>

The host this package is built for, either ‘win64’ or ‘linux64’

version: Option<String>

The version number for this package, e.g. ‘6.0.2’ or ‘6.0.pre6’

build_id: Option<isize>

The build ID for this package, later versions should have later IDs. This number should monotonically increase and only has meaning between two packages with the same build_id_namespace

build_id_namespace: Option<String>

An identifier for the build ID, e.g. ‘tsffs’

confidentiality: Option<String>

The confidentiality of the package, e.g. ‘Public’, but can be any string value based on the authors confidentiality requirements.

files: Vec<(String, String)>

A mapping from the path in the package to the full path on disk of the file.

typ: Option<String>

disabled: bool

Whether the package is disabled, default is not disabled

doc_title: Option<String>

The title used in documentation for the package

make_targets: Vec<String>

The list of targets to build for this package

include_release_notes: bool

Whether release notes should be included in the package, not included by default

ip_plans: Vec<String>

legacy_doc_make_targets: Vec<String>

release_notes: Vec<String>

access_labels: Vec<String>

Labels for managing package access, e.g. ‘external-intel’

Implementations

impl ManifestPackageSpec

pub fn default_type() -> String

Return the default type when deserializing

impl ManifestPackageSpec

pub fn from_package(package: &Package) -> Result<Self>

Create a specification from the package metadata returned from a cargo metadata invocation

pub fn from_subcommand(subcommand: &Subcommand) -> Result<Self>

Read the manifest specified by the subcommand and parse it into a package specification.

Trait Implementations

impl Clone for ManifestPackageSpec

fn clone(&self) -> ManifestPackageSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ManifestPackageSpec

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

Formats the value using the given formatter.

impl Default for ManifestPackageSpec

fn default() -> ManifestPackageSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ManifestPackageSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ManifestPackageSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.