Struct ObjectIdentifier 

pub struct ObjectIdentifier { /* private fields */ }

BACnet Object Identifier: 10-bit type + 22-bit instance number.

Uniquely identifies a BACnet object within a device. Encoded as a 4-byte big-endian value: (object_type << 22) | instance_number.

The all-ones instance value WILDCARD_INSTANCE is still a valid 22-bit wire value, and some service contexts give it wildcard meaning. Use ObjectIdentifier::new or ObjectIdentifier::decode when preserving wire-level values. Use ObjectIdentifier::new_addressable when constructing identifiers for concrete objects that can be stored, addressed, or compared as actual object instances.

Implementations

impl ObjectIdentifier

pub const MAX_INSTANCE: u32 = 0x3F_FFFF

Maximum encodable instance number (2^22 - 1 = 4,194,303).

This is also WILDCARD_INSTANCE. It is accepted by ObjectIdentifier::new and ObjectIdentifier::decode for wire compatibility, but callers that need a concrete addressable object should use MAX_ADDRESSABLE_INSTANCE or ObjectIdentifier::new_addressable.

pub const WILDCARD_INSTANCE: u32 = Self::MAX_INSTANCE

The reserved wildcard instance number (4,194,303).

BACnet service clauses assign this value special “any/local instance” meaning in selected contexts, for example Who-Is/Who-Am-I discovery and Device/Network Port object access. It is not a concrete object instance for addressable-object storage.

pub const MAX_ADDRESSABLE_INSTANCE: u32

Maximum instance number for a concrete addressable object (4,194,302).

This excludes WILDCARD_INSTANCE.

pub fn new(object_type: ObjectType, instance_number: u32) -> Result<Self, Error>

Create a new ObjectIdentifier from any valid 22-bit wire instance.

This constructor preserves WILDCARD_INSTANCE because it is a valid encoded value in BACnet service payloads. Use ObjectIdentifier::new_addressable when the identifier must name a concrete object instance.

Errors

Returns Err if instance_number exceeds MAX_INSTANCE.

pub fn new_addressable( object_type: ObjectType, instance_number: u32, ) -> Result<Self, Error>

Create a new ObjectIdentifier for a concrete addressable object.

This rejects WILDCARD_INSTANCE, while ObjectIdentifier::new keeps accepting that value for wire-level round trips and BACnet service contexts where it is meaningful.

Errors

Returns Err if instance_number exceeds MAX_INSTANCE or equals WILDCARD_INSTANCE.

pub const fn new_unchecked( object_type: ObjectType, instance_number: u32, ) -> Self

Create without validation. Caller must ensure instance <= MAX_INSTANCE.

pub const fn object_type(&self) -> ObjectType

The object type.

pub const fn instance_number(&self) -> u32

The instance number (0 to 4,194,303).

Values returned from wire decoding may equal WILDCARD_INSTANCE. Treat that value as a concrete addressable object only after the relevant service context has resolved its wildcard semantics.

pub fn encode(&self) -> [u8; 4]

Encode to the 4-byte BACnet wire format (big-endian).

pub fn decode(data: &[u8]) -> Result<Self, Error>

Decode from the 4-byte BACnet wire format (big-endian).

Trait Implementations

impl Clone for ObjectIdentifier

fn clone(&self) -> ObjectIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ObjectIdentifier

impl Debug for ObjectIdentifier

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

Formats the value using the given formatter.

impl Display for ObjectIdentifier

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

Formats the value using the given formatter.

impl Eq for ObjectIdentifier

impl Hash for ObjectIdentifier

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ObjectIdentifier

fn eq(&self, other: &ObjectIdentifier) -> 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 StructuralPartialEq for ObjectIdentifier