Struct AccessCredentialObject 

pub struct AccessCredentialObject { /* private fields */ }

BACnet Access Credential object (type 32).

Represents a credential (card, fob, biometric, etc.) used for access control. Table 12-40 has no Present_Value row, so the object serves none (#979).

Credential_Status is derived, not stored (Clause 12.35.8): INACTIVE while Reason_For_Disable lists anything, ACTIVE otherwise, so it is read-only. Reason_For_Disable is the sorted union of three sources (#1073):

• the reasons the application raises with add_disable_reason;
• the reason the current Credential_Disable value adds (Clause 12.35.13), so changing that property drops the reason its previous value added;
• DISABLED_NOT_YET_ACTIVE and DISABLED_EXPIRED, judged against the database’s wall clock each time the list is read, the way the Calendar follows the date (Clauses 12.35.11 and 12.35.12). Without a clock frame naming a real moment the window adds nothing.

The network may write Global_Identifier, Credential_Disable, Activation_Time and Expiration_Time. Authentication_Factors and Assigned_Access_Rights are BACnetARRAYs the application provisions.

The optional Authorization_Exemptions row (Clause 12.35.25; #1331) is served once the application sets it with set_authorization_exemptions, and is read-only over the network. With ACCESS_RIGHTS listed, evaluate_access_rights reports the credential exempt from the Access Rights check.

Implementations

impl AccessCredentialObject

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

Create a new Access Credential object: no disable reasons (so ACTIVE), Credential_Disable NONE, an open validity window, no global identifier and empty arrays.

pub fn set_global_identifier(&mut self, value: u32)

Set Global_Identifier; 0 means none is assigned (Clause 12.35.5).

pub fn set_credential_disable( &mut self, value: AccessCredentialDisable, ) -> Result<(), Error>

Set Credential_Disable. A value outside the four named ones and the vendor range 64 to 65535 is refused with VALUE_OUT_OF_RANGE.

pub fn set_activation_time( &mut self, date: Date, time: Time, ) -> Result<(), Error>

Set Activation_Time. Every octet X’FF’ leaves the start open; a partly specified value is refused with VALUE_OUT_OF_RANGE.

pub fn set_expiration_time( &mut self, date: Date, time: Time, ) -> Result<(), Error>

Set Expiration_Time, with the same rules as set_activation_time.

pub fn activation_time(&self) -> (Date, Time)

The stored Activation_Time.

pub fn expiration_time(&self) -> (Date, Time)

The stored Expiration_Time.

pub fn add_disable_reason( &mut self, reason: AccessCredentialDisableReason, ) -> Result<(), Error>

Raise a disable reason on behalf of the application, such as DISABLED_LOCKOUT after too many retries. Raising one already raised does nothing.

Refused with VALUE_OUT_OF_RANGE: a value outside the named reasons and the vendor range, and DISABLED_NOT_YET_ACTIVE and DISABLED_EXPIRED, which follow Activation_Time and Expiration_Time instead.

pub fn remove_disable_reason( &mut self, reason: AccessCredentialDisableReason, ) -> bool

Withdraw a reason the application raised; false if it wasn’t raised. Reasons from Credential_Disable or the validity window stay.

pub fn reason_for_disable(&self) -> Vec<AccessCredentialDisableReason>

Reason_For_Disable now: every source’s reasons, sorted by value without repeats.

pub fn credential_status(&self) -> BinaryPV

Credential_Status now: INACTIVE while any disable reason holds.

pub fn set_authentication_factors( &mut self, factors: Vec<BACnetCredentialAuthenticationFactor>, ) -> Result<(), Error>

Replace Authentication_Factors. Each element’s disable value must be named or in the vendor range and its format type one of the 25 named; otherwise VALUE_OUT_OF_RANGE and nothing changes.

pub fn authentication_factors(&self) -> &[BACnetCredentialAuthenticationFactor]

The stored Authentication_Factors.

pub fn set_assigned_access_rights( &mut self, rights: Vec<BACnetAssignedAccessRights>, ) -> Result<(), Error>

Replace Assigned_Access_Rights. Each element must reference an Access Rights object (or carry instance 4194303, the unused marker), and a device identifier, if present, must be a Device; otherwise VALUE_OUT_OF_RANGE and nothing changes.

pub fn assigned_access_rights(&self) -> &[BACnetAssignedAccessRights]

The stored Assigned_Access_Rights.

pub fn set_authorization_exemptions( &mut self, exemptions: Option<Vec<AuthorizationExemption>>, ) -> Result<(), Error>

Set Authorization_Exemptions (Clause 12.35.25), the authorization checks this credential is exempt from. Some serves the optional row, an empty list included, and adds it to Property_List; None leaves it out, as a new credential does. The list is read-only over the network.

A value outside the seven named checks and the vendor range 64 to 255 is refused with VALUE_OUT_OF_RANGE, keeping the list set before.

pub fn authorization_exemptions(&self) -> Option<&[AuthorizationExemption]>

The stored Authorization_Exemptions, None while the row is left out.

Trait Implementations

impl BACnetObject for AccessCredentialObject

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_cov(&self) -> bool

Whether this object type supports COV notifications.

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_reliability_internal( &mut self, _reliability: Reliability, ) -> Result<(), Error>

Apply an internally-derived Reliability value.

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 report_access_input_internal( &mut self, _input: AccessControlInput, ) -> Result<(), Error>

Apply an input the application reports for an access-control object the server holds (#1132): an Access Point’s access event, a Credential Data Input’s read or an Access Door’s hardware state, each a record whose values change together. See AccessControlInput.

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.