Struct autosar_data::ArxmlFile

pub struct ArxmlFile(_);

An Autosar arxml file

Implementations

impl ArxmlFile

pub fn filename(&self) -> PathBuf

Get the filename of this ArxmlFile

Example

println!("filename is : {}", file.filename().display());

pub fn set_filename<P: AsRef<Path>>(&self, new_filename: P)

Set the filename of this arxml filename

This will not rename any existing file on disk, but the new filename will be used when writing the data.

Example

file.set_filename("foo.arxml");
// or
file.set_filename(&Path::new("bar.arxml"));

pub fn version(&self) -> AutosarVersion

Get the AutosarVersion of the file

Example

let version = file.version();

pub fn set_version(
    &self,
    new_ver: AutosarVersion
) -> Result<(), AutosarDataError>

Set the AutosarVersion of the file

The compatibility of the data in the file with the new version will be checked before setting the version. The compatibility check can also be performed manually using the function check_version_compatibility().

If the data is compatible, then the version is set, otherwise an error is raised.

Example

file.set_version(AutosarVersion::Autosar_00050);

Possible Errors

• AutosarDataError::VersionIncompatible the existing data is not compatible with the new version

pub fn check_version_compatibility(
    &self,
    target_version: AutosarVersion
) -> (Vec<CompatibilityError>, u32)

Check if the elements and attributes in this file are compatible with some target_version

All elements and their attributes will be evaluated against the target version according to the specification. The output is a list of incompatible elements

Example

let (error_list, compat_mask) = file.check_version_compatibility(AutosarVersion::Autosar_00050);

pub fn project(&self) -> Result<AutosarProject, AutosarDataError>

Get a reference to the AutosarProject object that contains this file

Example

let project = AutosarProject::new();
let file = project.create_file("test", AutosarVersion::Autosar_00050).unwrap();
let p2 = file.project()?;
assert_eq!(project, p2);

Possible Errors

AutosarDataError::ItemDeleted: The project is no longer valid

pub fn root_element(&self) -> Element

Get a referenct to the root <AUTOSAR ...> element of this file

Example

let autosar_element = file.root_element();

pub fn elements_dfs(&self) -> ElementsDfsIterator

Create a depth-first search iterator over all Elements in this file

Example

for (depth, elem) in file.elements_dfs() {
    // ...
}

pub fn serialize(&self) -> String

Serialize the content of the file to a String

Example

let text = file.serialize();

pub fn downgrade(&self) -> WeakArxmlFile

Create a weak reference to this ArxmlFile

A weak reference can be stored without preventing the file from being deallocated. The weak reference has to be upgraded in order to be used, which can fail if the file no longer exists.

See the documentation for Arc

Example

let weak_file = file.downgrade();

Trait Implementations

impl Clone for ArxmlFile

fn clone(&self) -> ArxmlFile

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArxmlFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ArxmlFile> for ArxmlFile

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.