Struct TraceLink 

pub struct TraceLink {
    pub id: Uuid,
    pub artifact_type: ArtifactType,
    pub file_path: String,
    pub symbol: Option<String>,
    pub line_start: Option<u32>,
    pub line_end: Option<u32>,
    pub notes: Option<String>,
    pub created_at: DateTime<Utc>,
    pub created_by: Option<String>,
    pub commit_hash: Option<String>,
}

Represents a trace link between a requirement and a code artifact This enables bidirectional traceability: requirement -> code and code -> requirement

Fields

id: Uuid

Unique identifier for the trace link

artifact_type: ArtifactType

The type of artifact (source, test, config, doc)

file_path: String

Path to the file containing the artifact (relative to project root)

symbol: Option<String>

Optional symbol name (function, struct, module, etc.)

line_start: Option<u32>

Optional line range (start, end) where the implementation exists

line_end: Option<u32>

notes: Option<String>

Optional notes about this trace link

created_at: DateTime<Utc>

When this trace link was created

created_by: Option<String>

Who created this trace link

commit_hash: Option<String>

Git commit hash where this trace was identified (optional)

Implementations

impl TraceLink

pub fn new(artifact_type: ArtifactType, file_path: impl Into<String>) -> Self

Creates a new trace link

pub fn with_symbol(self, symbol: impl Into<String>) -> Self

Sets the symbol name

pub fn with_lines(self, start: u32, end: u32) -> Self

Sets the line range

pub fn with_notes(self, notes: impl Into<String>) -> Self

Sets notes

pub fn with_created_by(self, author: impl Into<String>) -> Self

Sets the creator

pub fn with_commit(self, hash: impl Into<String>) -> Self

Sets the commit hash

pub fn line_range(&self) -> Option<(u32, u32)>

Returns the line range as a tuple if both start and end are set

Trait Implementations

impl Clone for TraceLink

fn clone(&self) -> TraceLink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TraceLink

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TraceLink

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TraceLink

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TraceLink

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for TraceLink

type WithoutGenerics = TraceLink

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = TraceLink

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl Eq for TraceLink

impl StructuralPartialEq for TraceLink