🥮 mooncakes.io

isocontract

Object contract kernel for Isochronon

contract
fieldbus
moonbit
moon add mokomoking2501/isocontract@0.1.0
Download zip
Version
0.1.0
License
Apache-2.0
Last updated
last month
Downloads
17

Dependencies

README

#IsoContract

mokomoking2501/isocontract is the local Object Contract package for Isochronon. It owns protocol-neutral object contracts, binding records, contract lint, and trace-backed object monitoring.

///|
test "axis contracts lint" {
  let registry = axis_authority_contracts()
  assert_true(registry.lint().passes())
}

#
ContractIngestError

source
pub(all) suberror ContractIngestError {
  ParseFailed(String)
  MissingField(String)
  InvalidField(String, String)
} derive(
Debug)

#
Authority

source
pub(all) enum Authority {
  Any
  ReadOnly
  Role(String)
} derive(Eq, 
Debug)

#
Authority::allows

source
fn Authority::allows(self : Authority, node_id : String) -> Bool

#
Authority::label

source
fn Authority::label(self : Authority) -> String

#
BindingKind

source
pub(all) enum BindingKind {
  TraceLabel
  EtherCatPdo
  CoeSdo
  CanopenSdo
  CanopenPdo
  ZenohKey
  ModbusRegister
} derive(Eq, 
Debug)

#
BindingKind::label

source
fn BindingKind::label(self : BindingKind) -> String

#
ContractLintIssue

source
pub(all) struct ContractLintIssue {
  object_id : String?
  binding_id : String?
  message : String
} derive(Eq, 
Debug)

#
ContractLintReport

source
pub(all) struct ContractLintReport {
  issues : Array[ContractLintIssue]
} derive(Eq, 
Debug)

#
ContractLintReport::passes

source
fn ContractLintReport::passes(self : ContractLintReport) -> Bool

#
ContractRegistry

source
pub(all) struct ContractRegistry {
  objects : Array[ObjectContract]
} derive(
Debug)

#
ContractRegistry::contains_object

source
fn ContractRegistry::contains_object(self : ContractRegistry, object_id : String) -> Bool

#
ContractRegistry::copy

source

#
ContractRegistry::lint

source

#
ContractRegistry::new

source

#
ContractRegistry::register

source
fn ContractRegistry::register(self : ContractRegistry, contract : ObjectContract) -> Unit

#
ContractRegistry::with_object

source
fn ContractRegistry::with_object(self : ContractRegistry, contract : ObjectContract) -> ContractRegistry

#
ObjectBinding

source
pub(all) struct ObjectBinding {
  object_id : String
  binding_id : String
  medium_id : String
  label : String
  direction : 
TraceDirection?
  kind : BindingKind
  index : UInt?
  subindex : Byte?
  channel : String
  key : String
  authority : Authority
} derive(Eq, 
Debug)

#
ObjectBinding::make

source
fn ObjectBinding::make(object_id~ : String, binding_id~ : String, medium_id? : String, label~ : String, direction? : 
TraceDirection, kind? : BindingKind, index? : UInt, subindex? : Byte, channel? : String, key? : String, authority? : Authority) -> ObjectBinding

#
ObjectBinding::matches

source

#
ObjectClockRequirement

source
pub(all) enum ObjectClockRequirement {
  AnyClock
  PhysicalClock
} derive(Eq, 
Debug)

#
ObjectClockRequirement::label

source

#
ObjectContract

source
pub(all) struct ObjectContract {
  id : String
  kind : ObjectKind
  schema : Schema
  timing : TimingContract
  safety : SafetyContract
  bindings : Array[ObjectBinding]
} derive(Eq, 
Debug)

#
ObjectContract::make

source
fn ObjectContract::make(id~ : String, kind~ : ObjectKind, schema~ : Schema, timing~ : TimingContract, safety~ : SafetyContract) -> ObjectContract

#
ObjectContract::with_binding

source
fn ObjectContract::with_binding(self : ObjectContract, binding : ObjectBinding) -> ObjectContract

#
ObjectKind

source
pub(all) enum ObjectKind {
  Signal
  Command
  Query
  Event
  Lifecycle
} derive(Eq, 
Debug)

#
ObjectKind::label

source
fn ObjectKind::label(self : ObjectKind) -> String

#
ObjectMonitor

source
pub(all) struct ObjectMonitor {
  registry : ContractRegistry
} derive(
Debug)

#
ObjectMonitor::assess_trace

source

#
ObjectMonitor::check_trace

source

#
ObjectMonitor::new

source

#
ObjectMonitorAssessment

source
pub(all) struct ObjectMonitorAssessment {
  object_report : ObjectMonitorReport
  timeout_action_observation_count : Int
  timeout_action_evaluations : Array[ObjectTimeoutActionEvaluation]
  timeout_action_matched_count : Int
  timeout_action_missing_count : Int
  timeout_action_mismatch_count : Int
  timeout_action_duplicate_count : Int
  timeout_action_orphan_count : Int
} derive(Eq, 
Debug)

#
ObjectMonitorAssessment::passes

source

#
ObjectMonitorReport

source
pub(all) struct ObjectMonitorReport {
  checked_events : Int
  violations : Array[ObjectViolation]
} derive(Eq, 
Debug)

#
ObjectMonitorReport::passes

source
fn ObjectMonitorReport::passes(self : ObjectMonitorReport) -> Bool

#
ObjectTimeoutActionEvaluation

source
pub(all) struct ObjectTimeoutActionEvaluation {
  object_id : String
  trigger_event_id : Int
  expected_action : String
  observed_action : String
  observation_count : Int
  status : ObjectTimeoutActionStatus
} derive(Eq, 
Debug)

#
ObjectTimeoutActionObservation

source
pub(all) struct ObjectTimeoutActionObservation {
  object_id : String
  trigger_event_id : Int
  action : String
} derive(Eq, 
Debug)

#
ObjectTimeoutActionObservation::make

source
fn ObjectTimeoutActionObservation::make(object_id~ : String, trigger_event_id~ : Int, action~ : String) -> ObjectTimeoutActionObservation

#
ObjectTimeoutActionStatus

source
pub(all) enum ObjectTimeoutActionStatus {
  TimeoutActionMatched
  TimeoutActionMissing
  TimeoutActionMismatch
  TimeoutActionDuplicate
  TimeoutActionOrphan
} derive(Eq, 
Debug)

#
ObjectTimeoutActionStatus::label

source

#
ObjectViolation

source
pub(all) struct ObjectViolation {
  kind : ObjectViolationKind
  object_id : String
  event_id : Int?
  reason : String
} derive(Eq, 
Debug)

#
ObjectViolationKind

source
pub(all) enum ObjectViolationKind {
  AuthorityViolation
  TimingViolation
  PayloadRangeViolation
  TerminalFaultViolation
} derive(Eq, 
Debug)

#
ObjectViolationKind::label

source
fn ObjectViolationKind::label(self : ObjectViolationKind) -> String

#
SafetyContract

source
pub(all) struct SafetyContract {
  authority : Authority
  min_payload_digest : Int?
  max_payload_digest : Int?
  timeout_action : String
} derive(Eq, 
Debug)

#
SafetyContract::make

source
fn SafetyContract::make(authority? : Authority, min_payload_digest? : Int, max_payload_digest? : Int, timeout_action? : String) -> SafetyContract

#
Schema

source
pub(all) enum Schema {
  Bool
  I8
  I32
  U16
  State
  Text
} derive(Eq, 
Debug)

#
Schema::label

source
fn Schema::label(self : Schema) -> String

#
TimingContract

source
pub(all) struct TimingContract {
  period_ns : Int64?
  max_age_ns : Int64?
  deadline_ns : Int64?
  valid_for_ns : Int64?
  clock_requirement : ObjectClockRequirement
} derive(Eq, 
Debug)

#
TimingContract::empty

source

#
TimingContract::make

source
fn TimingContract::make(period_ns? : Int64, max_age_ns? : Int64, deadline_ns? : Int64, valid_for_ns? : Int64, clock_requirement? : ObjectClockRequirement) -> TimingContract

#
axis_authority_contracts

source
fn axis_authority_contracts() -> ContractRegistry

#
package_id

source
fn package_id() -> String

#
parse_contract_registry_json

source
fn parse_contract_registry_json(text : String) -> ContractRegistry raise ContractIngestError

#
parse_contract_registry_text

source
fn parse_contract_registry_text(text : String) -> ContractRegistry raise ContractIngestError

#
parse_contract_registry_yaml

source
fn parse_contract_registry_yaml(text : String) -> ContractRegistry raise ContractIngestError

Source Files

Powered by MoonBit

Site sourceReport issuePackagesBuild queueSkillsStatistics

© 2026 mooncakes.io