Struct ApiVisibilityComparison 

pub struct ApiVisibilityComparison { /* private fields */ }

One host-paired API visibility comparison.

This contract is intentionally atomic. The host must compare the same logical resource under the declared views before constructing it; the rule engine never combines independent UI, API, or principal observations. Context and scope identifiers must be opaque, non-secret handles. Raw credentials, tokens, URLs, response values, and resource names do not belong in this contract or its resulting evidence.

Examples

use termivar_core::{
    ApiSurfaceKind, ApiVisibilityComparison, ApiVisibilityDimension,
    ApiVisibilityPairKind, ApiVisibilityResult, ConfidenceScore,
};

let comparison = ApiVisibilityComparison::new(
    "comparison-17",
    ApiSurfaceKind::JsonHttp,
    ApiVisibilityPairKind::AuthorizationContext,
    ApiVisibilityResult::Different,
    ApiVisibilityDimension::Fields,
    "anonymous-context",
    "member-context",
    "account-resource",
)?;
let observation = comparison.to_observation("host.api-comparator", ConfidenceScore::MAX)?;
let evidence = observation.evidence();

assert!(evidence.subject().as_str().starts_with("api-comparison:"));
assert_eq!(evidence.source().correlation_id(), Some(evidence.subject().as_str()));
assert_eq!(observation.scope_relation().to(), observation.resource_scope());

Implementations

impl ApiVisibilityComparison

pub fn new( comparison_id: impl Into<String>, surface: ApiSurfaceKind, pair: ApiVisibilityPairKind, result: ApiVisibilityResult, dimension: ApiVisibilityDimension, baseline_context_id: impl Into<String>, candidate_context_id: impl Into<String>, resource_scope_id: impl Into<String>, ) -> Result<Self, ApiVocabularyError>

Creates one validated, already-paired observation.

pub fn new_typed( comparison_id: ComparisonId, surface: ApiSurfaceKind, pair: ApiVisibilityPairKind, result: ApiVisibilityResult, dimension: ApiVisibilityDimension, baseline_context_id: OpaqueContextId, candidate_context_id: OpaqueContextId, resource_scope_id: ResourceScopeId, ) -> Result<Self, ApiVocabularyError>

Creates one already-validated paired observation from typed identifiers.

The baseline and candidate remain checked here because individually valid context identifiers must still represent distinct views.

pub fn comparison_id(&self) -> &str

Returns the opaque host comparison identifier.

pub const fn typed_comparison_id(&self) -> &ComparisonId

Returns the typed opaque host comparison identifier.

pub const fn baseline_context_id(&self) -> &OpaqueContextId

Returns the typed opaque baseline context identifier.

pub const fn candidate_context_id(&self) -> &OpaqueContextId

Returns the typed opaque candidate context identifier.

pub const fn resource_scope_id(&self) -> &ResourceScopeId

Returns the typed opaque resource-scope identifier.

pub const fn surface(&self) -> ApiSurfaceKind

Returns the API surface that was compared.

pub const fn pair(&self) -> ApiVisibilityPairKind

Returns the pair of views that was compared.

pub const fn result(&self) -> ApiVisibilityResult

Returns the paired comparison result.

pub const fn dimension(&self) -> ApiVisibilityDimension

Returns the measured visibility dimension.

pub const fn observed_at_ms(&self) -> u64

Returns when the host constructed this paired observation.

pub fn with_observed_at_ms(self, observed_at_ms: u64) -> Self

Replaces the observation time for deterministic replay or import.

pub fn subject(&self) -> EntityId

Returns a raw-value-free, stable entity ID unique to this comparison.

This SHA-256 identity is pseudonymous, not a cryptographic attestation; hosts should supply non-secret, suitably opaque context handles.

pub fn resource_scope(&self) -> EntityId

Returns the opaque resource entity that the host compared.

pub fn to_observation( &self, component: impl Into<String>, reliability: ConfidenceScore, ) -> Result<ApiVisibilityObservation, ApiVocabularyError>

Emits the evidence and a stable evidence-backed resource-scope edge.

pub fn to_evidence( &self, component: impl Into<String>, reliability: ConfidenceScore, ) -> Result<Evidence, ApiVocabularyError>

Emits a detached immutable evidence record for this comparison.

The source correlation and subject use the same digest, so separate principals or comparison turns cannot contaminate one another. Prefer Self::to_observation for durable storage; callers using this lower- level method must persist an equivalent resource mapping themselves.

Trait Implementations

impl Clone for ApiVisibilityComparison

fn clone(&self) -> ApiVisibilityComparison

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiVisibilityComparison

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiVisibilityComparison

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ApiVisibilityComparison

impl PartialEq for ApiVisibilityComparison

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ApiVisibilityComparison

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ApiVisibilityComparison