pub struct AuditReporterObject { /* private fields */ }Expand description
BACnet AuditReporter object — configures which audit notifications to send.
Ordinary Reporters are always targets. Source ownership is an endpoint-private adapter, not a mutable flag or capability available from this crate.
ⓘ
use bacnet_objects::{audit::AuditReporterObject, database::ObjectDatabase, traits::BACnetObject};
let reporter = AuditReporterObject::new(1, "Reporter").unwrap();
let oid = reporter.object_identifier();
let mut db = ObjectDatabase::new();
db.add(Box::new(reporter)).unwrap();
AuditReporterObject::designate_source_internal(&mut db, oid).unwrap();ⓘ
use bacnet_objects::audit::SourceReporterBinding;Implementations§
Source§impl AuditReporterObject
impl AuditReporterObject
Sourcepub fn set_maximum_send_delay(
&mut self,
delay: Option<AuditSendDelay>,
) -> Result<(), Error>
pub fn set_maximum_send_delay( &mut self, delay: Option<AuditSendDelay>, ) -> Result<(), Error>
Author the optional delay/Send_Now pair, or change a live delay value. Presence is fixed throughout an active target ownership lifetime.
Source§impl AuditReporterObject
impl AuditReporterObject
Sourcepub fn set_audit_level(&mut self, level: AuditLevel) -> Result<(), Error>
pub fn set_audit_level(&mut self, level: AuditLevel) -> Result<(), Error>
Set Audit_Level; live admission failure leaves all state unchanged.
Sourcepub fn set_auditable_operations(
&mut self,
operations: AuditOperationFlags,
) -> Result<(), Error>
pub fn set_auditable_operations( &mut self, operations: AuditOperationFlags, ) -> Result<(), Error>
Set Auditable_Operations atomically with any required notification.
Sourcepub fn set_audit_priority_filter(
&mut self,
filter: BACnetPriorityFilter,
) -> Result<(), Error>
pub fn set_audit_priority_filter( &mut self, filter: BACnetPriorityFilter, ) -> Result<(), Error>
Set the command-priority filter atomically.
Sourcepub fn set_issue_confirmed_notifications(
&mut self,
confirmed: bool,
) -> Result<(), Error>
pub fn set_issue_confirmed_notifications( &mut self, confirmed: bool, ) -> Result<(), Error>
Set confirmed delivery mode atomically.
Sourcepub fn set_monitored_objects(
&mut self,
selectors: Option<Vec<BACnetObjectSelector>>,
) -> Result<(), Error>
pub fn set_monitored_objects( &mut self, selectors: Option<Vec<BACnetObjectSelector>>, ) -> Result<(), Error>
Set optional selectors: absent means catch-all; present empty means no nominal targets.
Trait Implementations§
Source§impl BACnetObject for AuditReporterObject
impl BACnetObject for AuditReporterObject
Source§fn object_identifier(&self) -> ObjectIdentifier
fn object_identifier(&self) -> ObjectIdentifier
The object’s identifier (type + instance).
Source§fn object_name(&self) -> &str
fn object_name(&self) -> &str
The object’s name.
Source§fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>
fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>
Return canonical metadata for this object’s effective property rows. Read more
Source§fn read_property(
&self,
property: PropertyIdentifier,
array_index: Option<u32>,
) -> Result<PropertyValue, Error>
fn read_property( &self, property: PropertyIdentifier, array_index: Option<u32>, ) -> Result<PropertyValue, Error>
Read a property value.
Source§fn write_property(
&mut self,
property: PropertyIdentifier,
array_index: Option<u32>,
value: PropertyValue,
_priority: Option<u8>,
) -> Result<(), Error>
fn write_property( &mut self, property: PropertyIdentifier, array_index: Option<u32>, value: PropertyValue, _priority: Option<u8>, ) -> Result<(), Error>
Write a property value. Read more
Source§fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>
List all properties this object supports in the legacy projection. Read more
Source§fn write_property_from(
&mut self,
property: PropertyIdentifier,
array_index: Option<u32>,
value: PropertyValue,
priority: Option<u8>,
_origin: &CommandOrigin,
) -> Result<(), Error>
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.
Source§fn is_writable_property(&self, property: PropertyIdentifier) -> bool
fn is_writable_property(&self, property: PropertyIdentifier) -> bool
Whether a property write route can accept
property for this object. Read moreSource§fn is_array_property(&self, property: PropertyIdentifier) -> bool
fn is_array_property(&self, property: PropertyIdentifier) -> bool
Whether
property accepts an array index on this object. Read moreSource§fn is_list_property(&self, property: PropertyIdentifier) -> bool
fn is_list_property(&self, property: PropertyIdentifier) -> bool
Whether
property is a BACnetLIST on this object. Read moreSource§fn is_createable(&self) -> bool
fn is_createable(&self) -> bool
Whether this object type can be created at runtime via CreateObject. Read more
Source§fn creation_only_properties(&self) -> &'static [PropertyIdentifier]
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. Read more
Source§fn initialize_property(
&mut self,
_property: PropertyIdentifier,
_value: PropertyValue,
) -> Result<(), Error>
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. Read moreSource§fn is_deleteable(&self) -> bool
fn is_deleteable(&self) -> bool
Whether this object type can be deleted at runtime via DeleteObject. Read more
Source§fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>
List the REQUIRED properties for this object type. Read more
Source§fn supports_cov(&self) -> bool
fn supports_cov(&self) -> bool
Whether this object type supports COV notifications. Read more
Source§fn supports_subscribe_cov_property(&self) -> bool
fn supports_subscribe_cov_property(&self) -> bool
Whether SubscribeCOVProperty and SubscribeCOVPropertyMultiple may
monitor this object’s properties. Read more
Source§fn supports_cov_property(&self, property: PropertyIdentifier) -> bool
fn supports_cov_property(&self, property: PropertyIdentifier) -> bool
Whether a readable property supports property-specific COV. Read more
Source§fn cov_increment(&self) -> Option<f64>
fn cov_increment(&self) -> Option<f64>
COV increment for this object (objects with a COV_Increment property). Read more
Source§fn cov_reported_properties(&self) -> &'static [CovReportedProperty]
fn cov_reported_properties(&self) -> &'static [CovReportedProperty]
Properties a whole-object (SubscribeCOV) notification reports after
its leading value and Status_Flags, in report order. Read more
Source§fn set_overridden(&mut self, _overridden: bool)
fn set_overridden(&mut self, _overridden: bool)
Set the OVERRIDDEN bit in StatusFlags. Read more
Source§fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
Evaluate intrinsic reporting after a present_value change. Read more
Source§fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>
Advance the
Time_Delay countdown for a pending transition. Read moreSource§fn tick_schedule(
&mut self,
_today: SpecificDate,
_time: Time,
_calendar_active: &dyn Fn(ObjectIdentifier) -> bool,
) -> Option<ScheduleWrite>
fn tick_schedule( &mut self, _today: SpecificDate, _time: Time, _calendar_active: &dyn Fn(ObjectIdentifier) -> bool, ) -> Option<ScheduleWrite>
Source§fn take_owed_schedule_writes(&mut self) -> Vec<ScheduleWrite>
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. Read more
Source§fn complete_schedule_write(
&mut self,
_write: &ScheduleWrite,
_outcomes: &[ScheduleTargetOutcome],
) -> bool
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. Read moreSource§fn retry_refusals_naming(
&self,
_target: ObjectIdentifier,
) -> Option<ScheduleWrite>
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.Source§fn acknowledge_alarm(
&mut self,
_transition_bit: EventTransitionBits,
) -> Result<(), Error>
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.Source§fn apply_life_safety_operation(
&mut self,
_operation: LifeSafetyOperation,
) -> Result<LifeSafetyOperationOutcome, Error>
fn apply_life_safety_operation( &mut self, _operation: LifeSafetyOperation, ) -> Result<LifeSafetyOperationOutcome, Error>
Apply a LifeSafetyOperation atomically to this object. Read more
Source§fn set_life_safety_operation_expected_internal(
&mut self,
_operation: LifeSafetyOperation,
) -> Result<(), Error>
fn set_life_safety_operation_expected_internal( &mut self, _operation: LifeSafetyOperation, ) -> Result<(), Error>
Set the next LifeSafetyOperation expected by trusted local logic. Read more
Source§fn set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>
fn set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>
Apply an internally-detected
Event_State transition. Read moreSource§fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>
fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>
Snapshot this object’s Event Enrollment evaluation state, if it models one. Read more
Source§fn set_enrollment_eval_state_internal(
&mut self,
_state: EventEnrollmentEvalState,
) -> Result<(), Error>
fn set_enrollment_eval_state_internal( &mut self, _state: EventEnrollmentEvalState, ) -> Result<(), Error>
Store this object’s Event Enrollment evaluation state. Read more
Source§fn enrollment_eval_source_internal(
&self,
) -> Option<Option<EventEnrollmentMonitoredSource>>
fn enrollment_eval_source_internal( &self, ) -> Option<Option<EventEnrollmentMonitoredSource>>
Snapshot the monitored source that owns Event Enrollment private state. Read more
Source§fn set_enrollment_eval_source_internal(
&mut self,
_source: Option<EventEnrollmentMonitoredSource>,
) -> Result<(), Error>
fn set_enrollment_eval_source_internal( &mut self, _source: Option<EventEnrollmentMonitoredSource>, ) -> Result<(), Error>
Store or clear the monitored source that owns Event Enrollment state.
Source§fn set_acked_transitions_internal(
&mut self,
_transition_bit: EventTransitionBits,
_acknowledged: bool,
) -> Result<(), Error>
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. Read moreSource§fn evaluate_reliability_internal(
&mut self,
) -> Result<ReliabilityEvaluation, Error>
fn evaluate_reliability_internal( &mut self, ) -> Result<ReliabilityEvaluation, Error>
Evaluate and, when necessary, mutate this object’s
Reliability. Read moreSource§fn set_reliability_internal(
&mut self,
_reliability: Reliability,
) -> Result<(), Error>
fn set_reliability_internal( &mut self, _reliability: Reliability, ) -> Result<(), Error>
Apply an internally-derived
Reliability value. Read moreSource§fn set_present_value_internal(
&mut self,
_value: PropertyValue,
) -> Result<(), Error>
fn set_present_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>
Apply the logical
Present_Value supplied by the local application. Read moreSource§fn set_present_value_from_internal(
&mut self,
value: PropertyValue,
_origin: &CommandOrigin,
) -> Result<(), Error>
fn set_present_value_from_internal( &mut self, value: PropertyValue, _origin: &CommandOrigin, ) -> Result<(), Error>
Source§fn set_tracking_value_internal(
&mut self,
_value: PropertyValue,
) -> Result<(), Error>
fn set_tracking_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>
Apply the
Tracking_Value the local application derived. Read moreSource§fn report_access_input_internal(
&mut self,
_input: AccessControlInput,
) -> Result<(), Error>
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. Read moreSource§fn set_controlled_variable_value_internal(
&mut self,
_value: PropertyValue,
) -> Result<(), Error>
fn set_controlled_variable_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>
Apply the Controlled_Variable_Value measured by the local application. Read more
Source§fn add_averaging_sample_internal(
&mut self,
_sample: Option<PropertyValue>,
) -> Result<(), Error>
fn add_averaging_sample_internal( &mut self, _sample: Option<PropertyValue>, ) -> Result<(), Error>
Record one sample for an Averaging object. Read more
Source§fn audit_log_storage_internal(&self) -> Option<&dyn AuditLogStorage>
fn audit_log_storage_internal(&self) -> Option<&dyn AuditLogStorage>
Borrow this object’s Audit Log query storage, if it has any. Read more
Source§fn audit_log_notification_sink_internal(
&mut self,
) -> Option<&mut dyn AuditLogNotificationSink>
fn audit_log_notification_sink_internal( &mut self, ) -> Option<&mut dyn AuditLogNotificationSink>
Mutably borrow this object’s Audit notification receiver capability. Read more
Source§fn file_storage_internal(&self) -> Option<&dyn FileStorage>
fn file_storage_internal(&self) -> Option<&dyn FileStorage>
Borrow this object’s File storage, if it has any. Read more
Source§fn file_storage_internal_mut(&mut self) -> Option<&mut dyn FileStorage>
fn file_storage_internal_mut(&mut self) -> Option<&mut dyn FileStorage>
Mutably borrow this object’s File storage, if it has any. Read more
Source§fn log_record_identities_internal(&self) -> Option<Vec<LogRecordIdentity>>
fn log_record_identities_internal(&self) -> Option<Vec<LogRecordIdentity>>
Return stable identities aligned with this object’s resident log records. Read more
Source§fn log_buffer_internal(&self) -> Option<&dyn LogBufferRecords>
fn log_buffer_internal(&self) -> Option<&dyn LogBufferRecords>
Borrow this object’s Log_Buffer records as ReadRange pages them. Read more
Source§fn add_trend_record(&mut self, _record: BACnetLogRecord) -> Result<(), Error>
fn add_trend_record(&mut self, _record: BACnetLogRecord) -> Result<(), Error>
Submit a trend record to an object’s log lifecycle. Read more
Source§fn add_trend_multiple_record(
&mut self,
_record: BACnetLogMultipleRecord,
) -> Result<(), Error>
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. Read more
Source§fn add_event_log_record(
&mut self,
_record: BACnetEventLogRecord,
) -> Result<(), Error>
fn add_event_log_record( &mut self, _record: BACnetEventLogRecord, ) -> Result<(), Error>
Submit an Event Log record to an object’s log lifecycle. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for AuditReporterObject
impl !UnwindSafe for AuditReporterObject
impl Freeze for AuditReporterObject
impl Send for AuditReporterObject
impl Sync for AuditReporterObject
impl Unpin for AuditReporterObject
impl UnsafeUnpin for AuditReporterObject
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more