Struct FileObject 

pub struct FileObject { /* private fields */ }

BACnet File object.

Represents a file accessible via AtomicReadFile / AtomicWriteFile services. The file_access_method determines whether the file is accessed as a byte stream (FileAccessMethod::STREAM_ACCESS) or as a sequence of fixed-length records (FileAccessMethod::RECORD_ACCESS).

Implementations

impl FileObject

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

Create a new File object.

Defaults to stream access (file_access_method = STREAM_ACCESS), empty data, not read-only, archive = false.

pub fn set_description(&mut self, desc: impl Into<String>)

Set the description.

pub fn set_file_type(&mut self, ft: impl Into<String>)

Set the file type string.

pub fn set_data(&mut self, data: Vec<u8>)

Set stream data; File_Size follows it unless the object is RECORD_ACCESS (any other access-method value, recognised or not, is the stream channel, as in set_file_access_method).

pub fn data(&self) -> &[u8]

Get a reference to the stream data.

pub fn set_file_access_method(&mut self, method: u32)

Set the file access method. Accepts the raw BACnetFileAccessMethod value: FileAccessMethod::STREAM_ACCESS (1) or FileAccessMethod::RECORD_ACCESS (0).

File_Size and Record_Count are recomputed from the channel the object switches to: Table 12-16 footnote 2 has Record_Count present only under RECORD_ACCESS, and File_Size counts that channel’s octets.

pub fn set_records(&mut self, records: Vec<Vec<u8>>)

Set the records; Record_Count and File_Size follow them while the object is RECORD_ACCESS (Table 12-16 footnote 2).

pub fn records(&self) -> &[Vec<u8>]

Get a reference to the records.

pub fn set_modification_date(&mut self, date: Date, time: Time)

Set the modification date.

pub fn set_archive(&mut self, archive: bool)

Set the archive flag.

pub fn set_read_only(&mut self, read_only: bool)

Set the read-only flag.

pub fn file_size(&self) -> u64

Get the file size in bytes.

pub fn archive(&self) -> bool

Get the archive flag.

pub fn read_only(&self) -> bool

Get the read-only flag.

pub fn set_max_file_size(&mut self, max_octets: u64)

Set the growth cap, in octets, for network writes to this file.

The cap bounds what AtomicWriteFile can add; it never invalidates contents preloaded through set_data, which may exceed it and still be overwritten in place. Clamped to i32::MAX so every resolved write position fits the ACK.

pub fn max_file_size(&self) -> u64

The growth cap, in octets, for network writes to this file.

pub fn set_max_record_count(&mut self, max_records: u64)

Set the growth cap, in records, for network writes to this file.

Same growth-only semantics as set_max_file_size: records preloaded through set_records are never refused. Clamped to DEFAULT_MAX_RECORD_COUNT, the decoder ceiling, so a file grown by network writes stays at or under what one AtomicReadFile-ACK carries; a larger preloaded file reads back in windows of at most that many records.

pub fn max_record_count(&self) -> u64

The growth cap, in records, for network writes to this file.

Trait Implementations

impl BACnetObject for FileObject

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 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 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 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.

impl FileStorage for FileObject

fn read_stream(&self, start: u64, count: u64) -> Result<FileStreamRead, Error>

Read up to count octets starting start octets into the file.

fn write_stream( &mut self, start: FileWriteStart, data: &[u8], ) -> Result<u64, Error>

Write data at start, extending the file first when start is past the end; intervening octets are a local matter. Returns the octet offset the data was written at, which for FileWriteStart::Append is the previous file size.

fn read_records(&self, start: u64, count: u64) -> Result<FileRecordRead, Error>

Read up to count records starting at record start.

fn write_records( &mut self, start: FileWriteStart, records: &[Vec<u8>], ) -> Result<u64, Error>

Write records starting at record start, replacing records in place and extending the file first when start is past the end. Returns the record index the data was written at.