Struct CredentialDataInputObject 

pub struct CredentialDataInputObject { /* private fields */ }

BACnet Credential Data Input object (type 37).

Represents a credential reader device (card reader, biometric scanner, etc.). Its Present_Value is the last factor read, a BACnetAuthenticationFactor (Clause 12.36.4), and Update_Time a BACnetTimeStamp (Clause 12.36.11); both go out in their Clause 21 forms. The enumerated BACnetAuthenticationStatus belongs to the Access Point’s Authentication_Status (Clause 12.31, Table 12-36), not here.

Supported_Formats and Supported_Format_Classes are BACnetARRAYs of the same size (Clause 12.36.9.1), so the object keeps them as one list of pairs, set by Self::set_supported_formats. Both take an array index. Present_Value always names one of those formats with its class, or is the UNDEFINED or ERROR factor (Clause 12.36.4; #1249): the module credential_data_input_formats has the rule and how each route keeps it.

While Out_Of_Service is TRUE a client can simulate Present_Value and Reliability by writing them, and the reader’s own values come back on the return to service (Table 12-43 footnote 1; #1168). The module credential_data_input_out_of_service has the details.

Implementations

impl CredentialDataInputObject

pub fn new(instance: u32, name: impl Into<String>) -> Result<Self, Error>

Create a new Credential Data Input object.

Until the first read, Present_Value is the UNDEFINED factor (format class 0, no value octets) and Update_Time the unspecified date and time (Clauses 12.36.4 and 12.36.11). It supports no format until Self::set_supported_formats declares some.

pub fn set_present_value( &mut self, factor: BACnetAuthenticationFactor, update_time: BACnetTimeStamp, ) -> Result<(), Error>

Record a factor the reader has read: Present_Value takes factor and Update_Time update_time, together, since Clause 12.36.11 moves Update_Time on every Present_Value update. Reading the same factor again is such an update.

The factor must name a declared format with the class declared beside it, or be the UNDEFINED or ERROR factor with class 0 (Clause 12.36.4); any other is refused with VALUE_OUT_OF_RANGE and nothing changes.

A change of Update_Time triggers a SubscribeCOV notification (Table 13-1). While Out_Of_Service is TRUE a client’s simulated values keep being served, and these take over on the return to service. A running server’s route, BACnetServer::report_credential_read_local, stores a read the same way (#1132).

pub fn set_supported_formats( &mut self, formats: impl IntoIterator<Item = (BACnetAuthenticationFactorFormat, u32)>, ) -> Result<(), Error>

Declare the formats this reader reads: Supported_Formats takes each pair’s format and Supported_Format_Classes, at the same position, the format class a factor read in it carries (Clauses 12.36.9 and 12.36.10). Zero is the class for a format that needs no differentiation.

Each format must be a named BACnetAuthenticationFactorType. A CUSTOM format must name its vendor and that vendor’s format number; any other format may carry those members only as zero (Clause 12.36.9). A list breaking either rule is refused with VALUE_OUT_OF_RANGE and the declared formats are kept.

A Present_Value whose format and class the new list doesn’t declare goes back to the UNDEFINED factor, with Update_Time stamped from the Device clock, or the object’s next sequence number when there is no usable clock (Clause 12.36.4). Out of service that covers both the simulated factor served and the reader’s factor put aside.

Trait Implementations

impl BACnetObject for CredentialDataInputObject

fn supports_cov(&self) -> bool

Table 13-1 lists Credential Data Input, so it takes SubscribeCOV.

fn report_access_input_internal( &mut self, input: AccessControlInput, ) -> Result<(), Error>

Take a read the application reports (#1132): Present_Value and Update_Time together, the time stamped from the Device clock, or the object’s next sequence number, when the report has none. Checked and stored as Self::set_present_value stores a read: while Out_Of_Service is TRUE it replaces the reader’s values put aside, and a client’s simulated ones stay served. Any other record is OPTIONAL_FUNCTIONALITY_NOT_SUPPORTED.

fn set_reliability_internal( &mut self, reliability: Reliability, ) -> Result<(), Error>

The application’s Reliability for the reader. Like the other Reliability carriers, the reader refuses it with WRITE_ACCESS_DENIED while Out_Of_Service is TRUE, so a client’s simulated value stays served; the return to service brings back the value from before. A value outside the BACnetReliability production is refused with VALUE_OUT_OF_RANGE.

fn object_identifier(&self) -> ObjectIdentifier

The object’s identifier (type + instance).

fn object_name(&self) -> &str

The object’s name.

fn read_property( &self, property: PropertyIdentifier, array_index: Option<u32>, ) -> Result<PropertyValue, Error>

Read a property value.

fn write_property( &mut self, property: PropertyIdentifier, array_index: Option<u32>, value: PropertyValue, _priority: Option<u8>, ) -> Result<(), Error>

Write a property value.

fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>

Return canonical metadata for this object’s effective property rows.

fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>

List all properties this object supports in the legacy projection.

fn write_property_from( &mut self, property: PropertyIdentifier, array_index: Option<u32>, value: PropertyValue, priority: Option<u8>, _origin: &CommandOrigin, ) -> Result<(), Error>

Write with explicit actual command provenance. Standalone callers assert the origin; server boundaries additionally validate ingress or membership. Decorators must forward this hook without discarding the origin. The default preserves custom/unaffected object behavior. First-party source-tracked commands require this hook and deny context-free writing.

fn is_writable_property(&self, property: PropertyIdentifier) -> bool

Whether a property write route can accept property for this object.

fn is_array_property(&self, property: PropertyIdentifier) -> bool

Whether property accepts an array index on this object.

fn is_list_property(&self, property: PropertyIdentifier) -> bool

Whether property is a BACnetLIST on this object.

fn is_createable(&self) -> bool

Whether this object type can be created at runtime via CreateObject.

fn creation_only_properties(&self) -> &'static [PropertyIdentifier]

The properties whose whole value a CreateObject initial value may set on this object although WriteProperty can’t change it afterwards.

fn initialize_property( &mut self, _property: PropertyIdentifier, _value: PropertyValue, ) -> Result<(), Error>

Apply a CreateObject initial value to one of Self::creation_only_properties, written whole.

fn is_deleteable(&self) -> bool

Whether this object type can be deleted at runtime via DeleteObject.

fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>

List the REQUIRED properties for this object type.

fn supports_subscribe_cov_property(&self) -> bool

Whether SubscribeCOVProperty and SubscribeCOVPropertyMultiple may monitor this object’s properties.

fn supports_cov_property(&self, property: PropertyIdentifier) -> bool

Whether a readable property supports property-specific COV.

fn cov_increment(&self) -> Option<f64>

COV increment for this object (objects with a COV_Increment property).

fn cov_reported_properties(&self) -> &'static [CovReportedProperty]

Properties a whole-object (SubscribeCOV) notification reports after its leading value and Status_Flags, in report order.

fn set_overridden(&mut self, _overridden: bool)

Set the OVERRIDDEN bit in StatusFlags.

fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>

Evaluate intrinsic reporting after a present_value change.

fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>

Advance the Time_Delay countdown for a pending transition.

fn tick_schedule( &mut self, _today: SpecificDate, _time: Time, _calendar_active: &dyn Fn(ObjectIdentifier) -> bool, ) -> Option<ScheduleWrite>

Evaluate this object’s schedule at time on today (Clause 12.24.4).

fn take_owed_schedule_writes(&mut self) -> Vec<ScheduleWrite>

Take the writes this schedule owes its targets apart from its calculation, each once, in order: a NULL to every priority slot a change of List_Of_Object_Property_References or Priority_For_Writing left behind (#1088), then the Present_Value owed out of service, for a client’s write (Clause 12.24.14) or a change of those two properties.

fn complete_schedule_write( &mut self, _write: &ScheduleWrite, _outcomes: &[ScheduleTargetOutcome], ) -> bool

Report how each target took write, one of this schedule’s writes: outcomes holds one entry per member of write.references, in order.

fn retry_refusals_naming( &self, _target: ObjectIdentifier, ) -> Option<ScheduleWrite>

The retry of the current value to the references whose last write was refused and that name target, an object just added to the database (#1440), so the refusal can clear without waiting for the next pass. None when no such refusal stands, or when the pass itself would retry nothing: out of service, outside Effective_Period, or with a NULL Present_Value. Only meaningful for Schedule objects; default returns None.

fn acknowledge_alarm( &mut self, _transition_bit: EventTransitionBits, ) -> Result<(), Error>

Acknowledge an alarm transition. Sets the transition_bit flags in acked_transitions. Returns Ok(()) if the object supports event detection, Err otherwise.

fn apply_life_safety_operation( &mut self, _operation: LifeSafetyOperation, ) -> Result<LifeSafetyOperationOutcome, Error>

Apply a LifeSafetyOperation atomically to this object.

fn set_life_safety_operation_expected_internal( &mut self, _operation: LifeSafetyOperation, ) -> Result<(), Error>

Set the next LifeSafetyOperation expected by trusted local logic.

fn set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>

Apply an internally-detected Event_State transition.

fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>

Snapshot this object’s Event Enrollment evaluation state, if it models one.

fn set_enrollment_eval_state_internal( &mut self, _state: EventEnrollmentEvalState, ) -> Result<(), Error>

Store this object’s Event Enrollment evaluation state.

fn enrollment_eval_source_internal( &self, ) -> Option<Option<EventEnrollmentMonitoredSource>>

Snapshot the monitored source that owns Event Enrollment private state.

fn set_enrollment_eval_source_internal( &mut self, _source: Option<EventEnrollmentMonitoredSource>, ) -> Result<(), Error>

Store or clear the monitored source that owns Event Enrollment state.

fn set_acked_transitions_internal( &mut self, _transition_bit: EventTransitionBits, _acknowledged: bool, ) -> Result<(), Error>

Set or clear one Acked_Transitions bit on a received event-state transition.

fn evaluate_reliability_internal( &mut self, ) -> Result<ReliabilityEvaluation, Error>

Evaluate and, when necessary, mutate this object’s Reliability.

fn set_present_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the logical Present_Value supplied by the local application.

fn set_present_value_from_internal( &mut self, value: PropertyValue, _origin: &CommandOrigin, ) -> Result<(), Error>

set_present_value_internal on behalf of origin, the local Device the application runs in.

fn set_tracking_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the Tracking_Value the local application derived.

fn set_controlled_variable_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the Controlled_Variable_Value measured by the local application.

fn add_averaging_sample_internal( &mut self, _sample: Option<PropertyValue>, ) -> Result<(), Error>

Record one sample for an Averaging object.

fn audit_log_storage_internal(&self) -> Option<&dyn AuditLogStorage>

Borrow this object’s Audit Log query storage, if it has any.

fn audit_log_notification_sink_internal( &mut self, ) -> Option<&mut dyn AuditLogNotificationSink>

Mutably borrow this object’s Audit notification receiver capability.

fn file_storage_internal(&self) -> Option<&dyn FileStorage>

Borrow this object’s File storage, if it has any.

fn file_storage_internal_mut(&mut self) -> Option<&mut dyn FileStorage>

Mutably borrow this object’s File storage, if it has any.

fn log_record_identities_internal(&self) -> Option<Vec<LogRecordIdentity>>

Return stable identities aligned with this object’s resident log records.

fn log_buffer_internal(&self) -> Option<&dyn LogBufferRecords>

Borrow this object’s Log_Buffer records as ReadRange pages them.

fn add_trend_record(&mut self, _record: BACnetLogRecord) -> Result<(), Error>

Submit a trend record to an object’s log lifecycle.

fn add_trend_multiple_record( &mut self, _record: BACnetLogMultipleRecord, ) -> Result<(), Error>

Submit a Trend Log Multiple record, one value per monitored member, to an object’s log lifecycle.

fn add_event_log_record( &mut self, _record: BACnetEventLogRecord, ) -> Result<(), Error>

Submit an Event Log record to an object’s log lifecycle.