README
- ::messageUaError::message
- ::newLocalizedText::new
- ::text_onlyLocalizedText::text_only
- ::to_stringLocalizedText::to_string
- ::bytesNodeId::bytes
- ::guidNodeId::guid
- ::numericNodeId::numeric
- ::stringNodeId::string
- ::to_stringNodeId::to_string
T
NodeIdIdentifier
- ::newQualifiedName::new
- ::to_stringQualifiedName::to_string
- ::defaultUaLimits::default
- ::from_bytesUaReader::from_bytes
- ::newUaReader::new
- ::positionUaReader::position
- ::read_boolUaReader::read_bool
- ::read_bytesUaReader::read_bytes
- ::read_doubleUaReader::read_double
- ::read_floatUaReader::read_float
- ::read_int16UaReader::read_int16
- ::read_int32UaReader::read_int32
- ::read_int64UaReader::read_int64
- ::read_localized_textUaReader::read_localized_text
- ::read_node_idUaReader::read_node_id
- ::read_qualified_nameUaReader::read_qualified_name
- ::read_required_bytesUaReader::read_required_bytes
- ::read_required_stringUaReader::read_required_string
- ::read_sbyteUaReader::read_sbyte
- ::read_stringUaReader::read_string
- ::read_u8UaReader::read_u8
- ::read_uint16UaReader::read_uint16
- ::read_uint32UaReader::read_uint32
- ::read_uint64UaReader::read_uint64
- ::remainingUaReader::remaining
- ::with_limitsUaReader::with_limits
- ::newUaWriter::new
- ::to_bytesUaWriter::to_bytes
- ::write_boolUaWriter::write_bool
- ::write_bytesUaWriter::write_bytes
- ::write_doubleUaWriter::write_double
- ::write_floatUaWriter::write_float
- ::write_int16UaWriter::write_int16
- ::write_int32UaWriter::write_int32
- ::write_int64UaWriter::write_int64
- ::write_localized_textUaWriter::write_localized_text
- ::write_node_idUaWriter::write_node_id
- ::write_nullable_bytesUaWriter::write_nullable_bytes
- ::write_nullable_stringUaWriter::write_nullable_string
- ::write_qualified_nameUaWriter::write_qualified_name
- ::write_sbyteUaWriter::write_sbyte
- ::write_stringUaWriter::write_string
- ::write_u8UaWriter::write_u8
- ::write_uint16UaWriter::write_uint16
- ::write_uint32UaWriter::write_uint32
- ::write_uint64UaWriter::write_uint64

moonua

Pure MoonBit OPC UA Binary Encoding primitives and data-model codecs.

opc-ua

binary-encoding

node-id

industrial

iot

protocol

Download zip

Author

oilleelssq-wq

Version

0.2.0

License

Apache-2.0

Repository

github.com/oilleelssq-wq/MoonUA

Last updated

7 hours ago

Downloads

#MoonUA

MoonUA 是一个纯 MoonBit 的 OPC UA Binary Encoding 基础库，面向工业设备、边缘网关、协议测试工具和数字孪生应用。

#当前功能

小端序 Boolean、SByte、Byte、Int16、UInt16
Int32、UInt32、Int64、UInt64、Float、Double
OPC UA String 和 ByteString，包含 null、长度和 UTF-8 检查
NodeId 的 TwoByte、FourByte、Numeric、String、Guid、Opaque 编码
QualifiedName 的 namespace index 和名称编码
LocalizedText 的 locale/text 掩码组合
类型化错误、边界检查、已知字节向量测试和可运行示例

#快速开始

import {
  "oilleelssq-wq/moonua" @moonua,
}

let writer = @moonua.UaWriter::new()
writer.write_node_id(@moonua.NodeId::numeric(1, 1000))
writer.write_qualified_name(@moonua.QualifiedName::new(1, "Device"))
let bytes = writer.to_bytes()

当前范围不包含网络传输、SecureChannel、Session、Variant、DataValue 或 ExtensionObject。这些能力会在后续阶段逐步加入。

#验证

moon fmt --check
moon check --deny-warn
moon test --deny-warn
moon test --target wasm
moon info
moon run examples/nodeid_demo --target wasm-gc

#许可

Apache License 2.0。

UaError

source

pub(all) suberror UaError {
  Truncated(Int, Int)
  InvalidLength(Int)
  LimitExceeded(Int, Int)
  InvalidUtf8
  InvalidNodeIdEncoding(UInt)
  InvalidGuidLength(Int)
  InvalidValue(String)
}

Errors raised while decoding OPC UA Binary Encoding data.

UaError::message

source

fn UaError::message(self : UaError) -> String

Human-readable error message.

LocalizedText

source

pub(all) struct LocalizedText {
  locale : String?
  text : String?
}

An OPC UA LocalizedText.

LocalizedText::new

source

fn LocalizedText::new(locale : String?, text : String?) -> LocalizedText

Construct a LocalizedText.

LocalizedText::text_only

source

fn LocalizedText::text_only(text : String) -> LocalizedText

Construct a text-only LocalizedText.

LocalizedText::to_string

source

fn LocalizedText::to_string(self : LocalizedText) -> String

Render a LocalizedText for diagnostics.

NodeId

source

pub(all) struct NodeId {
  namespace_index : UInt16
  identifier : NodeIdIdentifier
}

An OPC UA NodeId.

NodeId::bytes

source

fn NodeId::bytes(namespace_index : UInt16, identifier : Bytes) -> NodeId

Construct an opaque NodeId.

NodeId::guid

source

fn NodeId::guid(namespace_index : UInt16, identifier : Bytes) -> NodeId

Construct a Guid NodeId.

NodeId::numeric

source

fn NodeId::numeric(namespace_index : UInt16, identifier : UInt) -> NodeId

Construct a numeric NodeId.

NodeId::string

source

fn NodeId::string(namespace_index : UInt16, identifier : String) -> NodeId

Construct a string NodeId.

NodeId::to_string

source

fn NodeId::to_string(self : NodeId) -> String

Render a NodeId for diagnostics.

NodeIdIdentifier

source

pub(all) enum NodeIdIdentifier {
  Numeric(UInt)
  String(String)
  Guid(Bytes)
  Opaque(Bytes)
}

The identifier portion of an OPC UA NodeId.

QualifiedName

source

pub(all) struct QualifiedName {
  namespace_index : UInt16
  name : String
}

An OPC UA QualifiedName: a namespace index plus a name.

QualifiedName::new

source

fn QualifiedName::new(namespace_index : UInt16, name : String) -> QualifiedName

Construct a QualifiedName.

QualifiedName::to_string

source

fn QualifiedName::to_string(self : QualifiedName) -> String

Render a QualifiedName for diagnostics.

UaLimits

source

pub(all) struct UaLimits {
  max_byte_length : Int
}

Decoder resource limits.

UaLimits::default

source

fn UaLimits::default() -> UaLimits

Conservative defaults for untrusted binary input.

UaReader

source

pub(all) struct UaReader {
  data : BytesView
  offset : Int
  limits : UaLimits
}

A bounds-checked reader for OPC UA Binary Encoding.

UaReader::from_bytes

source

fn UaReader::from_bytes(data : Bytes) -> UaReader

Create a reader from owned bytes.

UaReader::new

source

fn UaReader::new(data : BytesView) -> UaReader

Create a reader with default limits.

UaReader::position

source

fn UaReader::position(self : UaReader) -> Int

Current byte offset.

UaReader::read_bool

source

fn UaReader::read_bool(self : UaReader) -> Bool raise UaError

Read a Boolean. OPC UA accepts zero and one only.

UaReader::read_bytes

source

fn UaReader::read_bytes(self : UaReader) -> Bytes? raise UaError

Read a nullable ByteString.

UaReader::read_double

source

fn UaReader::read_double(self : UaReader) -> Double raise UaError

Read a little-endian Double.

UaReader::read_float

source

fn UaReader::read_float(self : UaReader) -> Float raise UaError

Read a little-endian Float.

UaReader::read_int16

source

fn UaReader::read_int16(self : UaReader) -> Int raise UaError

Read a little-endian Int16.

UaReader::read_int32

source

fn UaReader::read_int32(self : UaReader) -> Int raise UaError

Read a little-endian Int32.

UaReader::read_int64

source

fn UaReader::read_int64(self : UaReader) -> Int64 raise UaError

Read a little-endian Int64.

UaReader::read_localized_text

source

fn UaReader::read_localized_text(self : UaReader) -> LocalizedText raise UaError

Decode a LocalizedText.

UaReader::read_node_id

source

fn UaReader::read_node_id(self : UaReader) -> NodeId raise UaError

Decode a NodeId.

UaReader::read_qualified_name

source

fn UaReader::read_qualified_name(self : UaReader) -> QualifiedName raise UaError

Decode a QualifiedName.

UaReader::read_required_bytes

source

fn UaReader::read_required_bytes(self : UaReader) -> Bytes raise UaError

Read a ByteString and reject null.

UaReader::read_required_string

source

fn UaReader::read_required_string(self : UaReader) -> String raise UaError

Read a String and reject null.

UaReader::read_sbyte

source

fn UaReader::read_sbyte(self : UaReader) -> Int raise UaError

Read a signed byte.

UaReader::read_string

source

fn UaReader::read_string(self : UaReader) -> String? raise UaError

Read a nullable OPC UA String.

UaReader::read_u8

source

fn UaReader::read_u8(self : UaReader) -> UInt raise UaError

Read an unsigned byte.

UaReader::read_uint16

source

fn UaReader::read_uint16(self : UaReader) -> UInt16 raise UaError

Read a little-endian UInt16.

UaReader::read_uint32

source

fn UaReader::read_uint32(self : UaReader) -> UInt raise UaError

Read a little-endian UInt32.

UaReader::read_uint64

source

fn UaReader::read_uint64(self : UaReader) -> UInt64 raise UaError

Read a little-endian UInt64.

UaReader::remaining

source

fn UaReader::remaining(self : UaReader) -> Int

Remaining bytes.

UaReader::with_limits

source

fn UaReader::with_limits(data : BytesView, limits : UaLimits) -> UaReader

Create a reader with explicit limits.

UaWriter

source

pub(all) struct UaWriter {
  buffer : @moonbitlang/core/buffer.Buffer
Buffer
}

A deterministic writer for OPC UA Binary Encoding.

UaWriter::new

source

fn UaWriter::new() -> UaWriter

Create an empty writer.

UaWriter::to_bytes

source

fn UaWriter::to_bytes(self : UaWriter) -> Bytes

Return the encoded bytes.

UaWriter::write_bool

source

fn UaWriter::write_bool(self : UaWriter, value : Bool) -> Unit

Write a Boolean.

UaWriter::write_bytes

source

fn UaWriter::write_bytes(self : UaWriter, value : Bytes) -> Unit raise UaError

Write a non-null ByteString.

UaWriter::write_double

source

fn UaWriter::write_double(self : UaWriter, value : Double) -> Unit

Write a little-endian Double.

UaWriter::write_float

source

fn UaWriter::write_float(self : UaWriter, value : Float) -> Unit

Write a little-endian Float.

UaWriter::write_int16

source

fn UaWriter::write_int16(self : UaWriter, value : Int) -> Unit raise UaError

Write a little-endian Int16.

UaWriter::write_int32

source

fn UaWriter::write_int32(self : UaWriter, value : Int) -> Unit

Write a little-endian Int32.

UaWriter::write_int64

source

fn UaWriter::write_int64(self : UaWriter, value : Int64) -> Unit

Write a little-endian Int64.

UaWriter::write_localized_text

source

fn UaWriter::write_localized_text(self : UaWriter, value : LocalizedText) -> Unit raise UaError

Encode a LocalizedText.

UaWriter::write_node_id

source

fn UaWriter::write_node_id(self : UaWriter, value : NodeId) -> Unit raise UaError

Encode a NodeId using the most compact numeric representation.

UaWriter::write_nullable_bytes

source

fn UaWriter::write_nullable_bytes(self : UaWriter, value : Bytes?) -> Unit raise UaError

Write a nullable ByteString.

UaWriter::write_nullable_string

source

fn UaWriter::write_nullable_string(self : UaWriter, value : String?) -> Unit raise UaError

Write a nullable OPC UA String.

UaWriter::write_qualified_name

source

fn UaWriter::write_qualified_name(self : UaWriter, value : QualifiedName) -> Unit raise UaError

Encode a QualifiedName.

UaWriter::write_sbyte

source

fn UaWriter::write_sbyte(self : UaWriter, value : Int) -> Unit raise UaError

Write one signed byte.

UaWriter::write_string

source

fn UaWriter::write_string(self : UaWriter, value : String) -> Unit raise UaError

Write a non-null OPC UA String.

UaWriter::write_u8

source

fn UaWriter::write_u8(self : UaWriter, value : UInt) -> Unit

Write one unsigned byte.

UaWriter::write_uint16

source

fn UaWriter::write_uint16(self : UaWriter, value : UInt16) -> Unit

Write a little-endian UInt16.

UaWriter::write_uint32

source

fn UaWriter::write_uint32(self : UaWriter, value : UInt) -> Unit

Write a little-endian UInt32.

UaWriter::write_uint64

source

fn UaWriter::write_uint64(self : UaWriter, value : UInt64) -> Unit

Write a little-endian UInt64.

Source Files

Site source Report issue Packages Build queue Skills Statistics

moonua

#MoonUA

#当前功能

#快速开始

#验证

#许可

#UaError

#UaError::message

#LocalizedText

#LocalizedText::new

#LocalizedText::text_only

#LocalizedText::to_string

#NodeId

#NodeId::bytes

#NodeId::guid

#NodeId::numeric

#NodeId::string

#NodeId::to_string

#NodeIdIdentifier

#QualifiedName

#QualifiedName::new

#QualifiedName::to_string

#UaLimits

#UaLimits::default

#UaReader

#UaReader::from_bytes

#UaReader::new

#UaReader::position

#UaReader::read_bool

#UaReader::read_bytes

#UaReader::read_double

#UaReader::read_float

#UaReader::read_int16

#UaReader::read_int32

#UaReader::read_int64

#UaReader::read_localized_text

#UaReader::read_node_id

#UaReader::read_qualified_name

#UaReader::read_required_bytes

#UaReader::read_required_string

#UaReader::read_sbyte

#UaReader::read_string

#UaReader::read_u8

#UaReader::read_uint16

#UaReader::read_uint32

#UaReader::read_uint64

#UaReader::remaining

#UaReader::with_limits

#UaWriter

#UaWriter::new

#UaWriter::to_bytes

#UaWriter::write_bool

#UaWriter::write_bytes

#UaWriter::write_double

#UaWriter::write_float

#UaWriter::write_int16

#UaWriter::write_int32

#UaWriter::write_int64

#UaWriter::write_localized_text

#UaWriter::write_node_id

#UaWriter::write_nullable_bytes

#UaWriter::write_nullable_string

#UaWriter::write_qualified_name

#UaWriter::write_sbyte

#UaWriter::write_string

#UaWriter::write_u8

#UaWriter::write_uint16

#UaWriter::write_uint32

#UaWriter::write_uint64

Source Files

UaError

UaError::message

LocalizedText

LocalizedText::new

LocalizedText::text_only

LocalizedText::to_string

NodeId

NodeId::bytes

NodeId::guid

NodeId::numeric

NodeId::string

NodeId::to_string

NodeIdIdentifier

QualifiedName

QualifiedName::new

QualifiedName::to_string

UaLimits

UaLimits::default

UaReader

UaReader::from_bytes

UaReader::new

UaReader::position

UaReader::read_bool

UaReader::read_bytes

UaReader::read_double

UaReader::read_float

UaReader::read_int16

UaReader::read_int32

UaReader::read_int64

UaReader::read_localized_text

UaReader::read_node_id

UaReader::read_qualified_name

UaReader::read_required_bytes

UaReader::read_required_string

UaReader::read_sbyte

UaReader::read_string

UaReader::read_u8

UaReader::read_uint16

UaReader::read_uint32

UaReader::read_uint64

UaReader::remaining

UaReader::with_limits

UaWriter

UaWriter::new

UaWriter::to_bytes

UaWriter::write_bool

UaWriter::write_bytes

UaWriter::write_double

UaWriter::write_float

UaWriter::write_int16

UaWriter::write_int32

UaWriter::write_int64

UaWriter::write_localized_text

UaWriter::write_node_id

UaWriter::write_nullable_bytes

UaWriter::write_nullable_string

UaWriter::write_qualified_name

UaWriter::write_sbyte

UaWriter::write_string

UaWriter::write_u8

UaWriter::write_uint16

UaWriter::write_uint32

UaWriter::write_uint64