Struct SourceMetadataExport 

pub struct SourceMetadataExport<'a> {
    pub package: &'a str,
    pub component: &'a str,
    pub executable: Option<&'a str>,
    pub exported_symbol: Option<&'a str>,
    pub package_manifest: &'a str,
    pub source_artifacts: &'a [&'a str],
    pub language: &'a str,
}

Source metadata document settings used by the std JSON emitter.

Fields

package: &'a str

component: &'a str

executable: Option<&'a str>

exported_symbol: Option<&'a str>

package_manifest: &'a str

source_artifacts: &'a [&'a str]

language: &'a str

phase-308 — the source language the sidecar describes ("rust", "c", "cpp"). It was a hardcoded "rust" literal in the serializer while Rust was the only producer; the C/C++ producer reaches this SAME serializer, so the value has to come from the caller. The consumption side keys on (package, executable) and never branches on it, but the schema declares it and a wrong value is a lie in the artifact.

Implementations

impl<'a> SourceMetadataExport<'a>

pub const fn new(package: &'a str, component: &'a str) -> Self

Create export settings with ROS package and component names.

pub const fn language(self, language: &'a str) -> Self

Set the source language ("c" / "cpp"; defaults to "rust").

pub const fn executable(self, executable: &'a str) -> Self

Set executable name.

pub const fn exported_symbol(self, exported_symbol: &'a str) -> Self

Set exported symbol name.

pub const fn package_manifest(self, package_manifest: &'a str) -> Self

Set package manifest path.

pub const fn source_artifacts(self, source_artifacts: &'a [&'a str]) -> Self

Set source artifact paths.

Trait Implementations

impl<'a> Clone for SourceMetadataExport<'a>

fn clone(&self) -> SourceMetadataExport<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SourceMetadataExport<'a>

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

Formats the value using the given formatter.