README
E
ContractIngestError
- ::allowsAuthority::allows
- ::labelAuthority::label
- ::labelBindingKind::label
T
ContractLintIssue
- ::passesContractLintReport::passes
- ::contains_objectContractRegistry::contains_object
- ::copyContractRegistry::copy
- ::lintContractRegistry::lint
- ::newContractRegistry::new
- ::registerContractRegistry::register
- ::with_objectContractRegistry::with_object
- ::makeObjectBinding::make
- ::matchesObjectBinding::matches
- ::labelObjectClockRequirement::label
- ::makeObjectContract::make
- ::with_bindingObjectContract::with_binding
- ::labelObjectKind::label
- ::assess_traceObjectMonitor::assess_trace
- ::check_traceObjectMonitor::check_trace
- ::newObjectMonitor::new
- ::passesObjectMonitorAssessment::passes
- ::passesObjectMonitorReport::passes
T
ObjectTimeoutActionEvaluation
- ::makeObjectTimeoutActionObservation::make
- ::labelObjectTimeoutActionStatus::label
T
ObjectViolation
- ::labelObjectViolationKind::label
- ::makeSafetyContract::make
- ::labelSchema::label
- ::emptyTimingContract::empty
- ::makeTimingContract::make
V
axis_authority_contracts
V
package_id
V
parse_contract_registry_json
V
parse_contract_registry_text
V
parse_contract_registry_yaml

isocontract

Object contract kernel for Isochronon

contract

fieldbus

moonbit

Download zip

Author

mokomoking2501

Version

0.1.0

License

Apache-2.0

Last updated

3 months ago

Downloads

mokomoking2501/lockwire0.1.0

#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(@moonbitlang/core/debug.Debug
Debug)

Authority

source

pub(all) enum Authority {
  Any
  ReadOnly
  Role(String)
} derive(Eq, @moonbitlang/core/debug.Debug
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, @moonbitlang/core/debug.Debug
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, @moonbitlang/core/debug.Debug
Debug)

ContractLintReport

source

pub(all) struct ContractLintReport {
  issues : Array[ContractLintIssue]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ContractLintReport::passes

source

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

ContractRegistry

source

pub(all) struct ContractRegistry {
  objects : Array[ObjectContract]
} derive(@moonbitlang/core/debug.Debug
Debug)

ContractRegistry::contains_object

source

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

ContractRegistry::copy

source

fn ContractRegistry::copy(self : ContractRegistry) -> ContractRegistry

ContractRegistry::lint

source

fn ContractRegistry::lint(self : ContractRegistry) -> ContractLintReport

ContractRegistry::new

source

fn ContractRegistry::new() -> ContractRegistry

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 : @mokomoking2501/lockwire/trace.TraceDirection
TraceDirection?
  kind : BindingKind
  index : UInt?
  subindex : Byte?
  channel : String
  key : String
  authority : Authority
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ObjectBinding::make

source

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

ObjectBinding::matches

source

fn ObjectBinding::matches(self : ObjectBinding, event : @mokomoking2501/lockwire/trace.TraceEvent
TraceEvent) -> Bool

ObjectClockRequirement

source

pub(all) enum ObjectClockRequirement {
  AnyClock
  PhysicalClock
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ObjectClockRequirement::label

source

fn ObjectClockRequirement::label(self : ObjectClockRequirement) -> String

ObjectContract

source

pub(all) struct ObjectContract {
  id : String
  kind : ObjectKind
  schema : Schema
  timing : TimingContract
  safety : SafetyContract
  bindings : Array[ObjectBinding]
} derive(Eq, @moonbitlang/core/debug.Debug
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, @moonbitlang/core/debug.Debug
Debug)

ObjectKind::label

source

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

ObjectMonitor

source

pub(all) struct ObjectMonitor {
  registry : ContractRegistry
} derive(@moonbitlang/core/debug.Debug
Debug)

ObjectMonitor::assess_trace

source

fn ObjectMonitor::assess_trace(self : ObjectMonitor, log : @mokomoking2501/lockwire/trace.TraceLog
TraceLog, timeout_actions : ArrayView[ObjectTimeoutActionObservation]) -> ObjectMonitorAssessment

ObjectMonitor::check_trace

source

fn ObjectMonitor::check_trace(self : ObjectMonitor, log : @mokomoking2501/lockwire/trace.TraceLog
TraceLog) -> ObjectMonitorReport

ObjectMonitor::new

source

fn ObjectMonitor::new(registry~ : ContractRegistry) -> ObjectMonitor

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, @moonbitlang/core/debug.Debug
Debug)

ObjectMonitorAssessment::passes

source

fn ObjectMonitorAssessment::passes(self : ObjectMonitorAssessment) -> Bool

ObjectMonitorReport

source

pub(all) struct ObjectMonitorReport {
  checked_events : Int
  violations : Array[ObjectViolation]
} derive(Eq, @moonbitlang/core/debug.Debug
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, @moonbitlang/core/debug.Debug
Debug)

ObjectTimeoutActionObservation

source

pub(all) struct ObjectTimeoutActionObservation {
  object_id : String
  trigger_event_id : Int
  action : String
} derive(Eq, @moonbitlang/core/debug.Debug
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, @moonbitlang/core/debug.Debug
Debug)

ObjectTimeoutActionStatus::label

source

fn ObjectTimeoutActionStatus::label(self : ObjectTimeoutActionStatus) -> String

ObjectViolation

source

pub(all) struct ObjectViolation {
  kind : ObjectViolationKind
  object_id : String
  event_id : Int?
  reason : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ObjectViolationKind

source

pub(all) enum ObjectViolationKind {
  AuthorityViolation
  TimingViolation
  PayloadRangeViolation
  TerminalFaultViolation
} derive(Eq, @moonbitlang/core/debug.Debug
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, @moonbitlang/core/debug.Debug
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, @moonbitlang/core/debug.Debug
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, @moonbitlang/core/debug.Debug
Debug)

TimingContract::empty

source

fn TimingContract::empty() -> TimingContract

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

Install

Download zip

Object contract kernel for Isochronon

contractfieldbusmoonbit

mokomoking2501

Apache-2.0

Updated 3 months ago

49 downloads

Site source Report issue Modules Skills Build queue Statistics

isocontract

#IsoContract

#ContractIngestError

#Authority

#Authority::allows

#Authority::label

#BindingKind

#BindingKind::label

#ContractLintIssue

#ContractLintReport

#ContractLintReport::passes

#ContractRegistry

#ContractRegistry::contains_object

#ContractRegistry::copy

#ContractRegistry::lint

#ContractRegistry::new

#ContractRegistry::register

#ContractRegistry::with_object

#ObjectBinding

#ObjectBinding::make

#ObjectBinding::matches

#ObjectClockRequirement

#ObjectClockRequirement::label

#ObjectContract

#ObjectContract::make

#ObjectContract::with_binding

#ObjectKind

#ObjectKind::label

#ObjectMonitor

#ObjectMonitor::assess_trace

#ObjectMonitor::check_trace

#ObjectMonitor::new

#ObjectMonitorAssessment

#ObjectMonitorAssessment::passes

#ObjectMonitorReport

#ObjectMonitorReport::passes

#ObjectTimeoutActionEvaluation

#ObjectTimeoutActionObservation

#ObjectTimeoutActionObservation::make

#ObjectTimeoutActionStatus

#ObjectTimeoutActionStatus::label

#ObjectViolation

#ObjectViolationKind

#ObjectViolationKind::label

#SafetyContract

#SafetyContract::make

#Schema

#Schema::label

#TimingContract

#TimingContract::empty

#TimingContract::make

#axis_authority_contracts

#package_id

#parse_contract_registry_json

#parse_contract_registry_text

#parse_contract_registry_yaml

Source Files

ContractIngestError

Authority

Authority::allows

Authority::label

BindingKind

BindingKind::label

ContractLintIssue

ContractLintReport

ContractLintReport::passes

ContractRegistry

ContractRegistry::contains_object

ContractRegistry::copy

ContractRegistry::lint

ContractRegistry::new

ContractRegistry::register

ContractRegistry::with_object

ObjectBinding

ObjectBinding::make

ObjectBinding::matches

ObjectClockRequirement

ObjectClockRequirement::label

ObjectContract

ObjectContract::make

ObjectContract::with_binding

ObjectKind

ObjectKind::label

ObjectMonitor

ObjectMonitor::assess_trace

ObjectMonitor::check_trace

ObjectMonitor::new

ObjectMonitorAssessment

ObjectMonitorAssessment::passes

ObjectMonitorReport

ObjectMonitorReport::passes

ObjectTimeoutActionEvaluation

ObjectTimeoutActionObservation

ObjectTimeoutActionObservation::make

ObjectTimeoutActionStatus

ObjectTimeoutActionStatus::label

ObjectViolation

ObjectViolationKind

ObjectViolationKind::label

SafetyContract

SafetyContract::make

Schema

Schema::label

TimingContract

TimingContract::empty

TimingContract::make

axis_authority_contracts

package_id

parse_contract_registry_json

parse_contract_registry_text

parse_contract_registry_yaml