Struct DeviceIdentity 

pub struct DeviceIdentity { /* private fields */ }

Single Device identity source.

Owns the Device declarations shared by a server and an endpoint. Resolve the requested receive ceiling against the owned transport before generating a stock Device or validating a supplied one. Services and Network Ports are configuration data; each executor controls its served service profile.

use bacnet_objects::device_identity::DeviceIdentity;

let identity = DeviceIdentity::new(1001, 42)?;
assert_eq!(identity.instance(), 1001);
assert_eq!(identity.vendor_id(), 42);

Implementations

impl DeviceIdentity

pub fn new(instance: u32, vendor_id: u16) -> Result<DeviceIdentity, Error>

Creates an identity with endpoint-composed defaults.

Defaults: max_apdu = 1476, segmentation = NONE, services = [READ_PROPERTY] (narrow endpoint reality, no superset), no ports, zero UUID (B/IP-only may keep zeros; SC dial requires with_device_uuid). Returns Error::Encoding for an out-of-range Device instance.

pub fn with_max_apdu(self, max_apdu: u16) -> Result<DeviceIdentity, Error>

Sets the raw requested receive ceiling (at least 50 bytes).

Discovery and Device reads preserve this raw value, including 1474. Confirmed-Request header encoders floor it separately. Startup resolves it against the owned transport’s stable local receive capacity.

pub fn with_segmentation(self, segmentation: Segmentation) -> DeviceIdentity

Overrides segmentation support for a matching full server.

Narrow EndpointSession roles require NONE and reject any other identity before ingress starts. A full server uses this declaration with the segment timeout supplied by this identity.

pub fn with_apdu_segment_timeout_ms(self, timeout_ms: u64) -> DeviceIdentity

Sets the Device and full-server segment timeout. EndpointSession roles require segmentation NONE; client timers remain caller-owned.

pub fn with_services(self, services: &[ServiceSupported]) -> DeviceIdentity

Overrides the services profile (must equal what roles can do; no superset).

Default [READ_PROPERTY] matches the narrow endpoint responder. EndpointSession::with_device_writes adds WRITE_PROPERTY and EndpointSession::with_reinitialize adds REINITIALIZE_DEVICE; other service bits are rejected. Server-role startup also rejects missing ReadProperty or unsupported bits with neither opt-in, before ingress starts. ClientOnly has no responder and retains this as a local declaration. Broader executing profiles require a matching full server.

pub fn with_device_uuid(self, uuid: [u8; 16]) -> DeviceIdentity

Stores the durable caller-owned SC device UUID (no generation/storage).

The caller provisions 16 bytes durably and reuses them for the device lifetime. SC hub-dial rejects all-zero; B/IP-only identities may keep zeros.

pub fn with_name(self, name: impl Into<String>) -> DeviceIdentity

Overrides the Device object name (defaults to device-{instance}).

pub fn with_network_port( self, entry: NetworkPortEntry, ) -> Result<DeviceIdentity, Error>

Adds one validated configured Network-Port entry.

Rejects duplicate instances and out-of-range Network-Port instances and invalid profile configuration. Prefer with_bip_port, with_bip6_port or with_sc_port, which encode the population rule.

pub fn with_bip_port( self, instance: u32, network_number: u32, ip: Ipv4Addr, udp_port: u16, ) -> Result<DeviceIdentity, Error>

Adds a B/IP port entry with configured IP/UDP values, including UDP zero.

pub fn with_bip6_port( self, instance: u32, network_number: u32, ip: Ipv6Addr, udp_port: u16, ) -> Result<DeviceIdentity, Error>

Adds a B/IPv6 port entry with the configured IPv6 address and UDP port, including UDP zero. See NetworkPortEntry::bip6.

pub fn with_sc_port( self, instance: u32, network_number: u32, vmac: [u8; 6], ) -> Result<DeviceIdentity, Error>

Adds an SC port entry keyed by VMAC.

pub fn instance(&self) -> u32

Device instance number.

pub fn vendor_id(&self) -> u16

Vendor identifier (I-Am + Device VENDOR_IDENTIFIER).

pub fn max_apdu_length(&self) -> u16

Raw requested or resolved local receive ceiling.

pub fn name(&self) -> &str

Device object name.

pub fn apdu_segment_timeout_ms(&self) -> u64

Segment timeout in milliseconds. The shared default is 5000 ms.

pub fn resolve( &self, local_receive_capacity: u16, ) -> Result<DeviceIdentity, Error>

Resolve the requested receive ceiling before any transport I/O.

pub fn validate(&self) -> Result<(), Error>

Check the pure Device declaration. Executors also validate deadlines.

pub fn validate_device(&self, device: &dyn BACnetObject) -> Result<(), Error>

Validate a supplied Device without rebuilding it or changing its state.

pub fn segmentation(&self) -> Segmentation

Segmentation support (I-Am + Device SEGMENTATION_SUPPORTED).

pub fn services(&self) -> &[ServiceSupported]

Services profile (Device PROTOCOL_SERVICES_SUPPORTED; no superset).

pub fn network_ports(&self) -> &[NetworkPortEntry]

Configured Network-Port entries, independent of live transport binding.

pub fn device_uuid(&self) -> [u8; 16]

Durable caller-owned SC device UUID.

pub fn device_oid(&self) -> ObjectIdentifier

Device object identifier derived from the instance.

pub fn build_database(&self) -> Result<ObjectDatabase, Error>

Constructs the ObjectDatabase (Device + Network-Port + DEVICE_UUID).

Truth direction: identity -> database. For extra application objects use build_database_with_extra: it seeds Object_List with Device + ports + extras upfront so no post-add mutation is needed.

Trait Implementations

impl Clone for DeviceIdentity

fn clone(&self) -> DeviceIdentity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceIdentity

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

Formats the value using the given formatter.

impl Default for DeviceIdentity

fn default() -> DeviceIdentity

Returns the “default value” for a type.