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 (0) or as a sequence of fixed-length records (1).

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 = 0), 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 and update file_size accordingly.

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 (0 = stream, 1 = record).

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

Set the records (for record-access files) and update record_count.

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.

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_list(&self) -> Cow<'static, [PropertyIdentifier]>

List all properties this object supports.

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

List the REQUIRED properties for this object type.

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

COV increment for this object (analog objects only).

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

Evaluate intrinsic reporting after a present_value change.

fn tick_schedule( &mut self, _day_of_week: u8, _hour: u8, _minute: u8, ) -> Option<(PropertyValue, Vec<(ObjectIdentifier, u32)>)>

Evaluate this object’s schedule for the given time (Clause 12.24).

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

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

fn add_trend_record(&mut self, _record: BACnetLogRecord)

Add a trend log record (only meaningful for TrendLog / TrendLogMultiple).