Struct AutosarModel 

pub struct AutosarModel(/* private fields */);

AutosarModel is the top level data type in the autosar-data crate.

An instance of AutosarModel is required for all other operations.

The model contains the hierarchy of Autosar elements. It can be created manually or loaded from one or more arxml files. It stores the association between elements and files. In addition, this top-level structure provides caching of Autosar paths, to allow quick resolution of cross-references.

Implementations

impl AutosarModel

pub fn new() -> AutosarModel

Create an AutosarData model

Initially it contains no arxml files and only has a default <AUTOSAR> element

Example

let model = AutosarModel::new();

pub fn create_file<P: AsRef<Path>>( &self, filename: P, version: AutosarVersion, ) -> Result<ArxmlFile, AutosarDataError>

Create a new ArxmlFile inside this AutosarData structure

You must provide a filename for the ArxmlFile, even if you do not plan to write the data to disk. You must also specify an AutosarVersion. All methods manipulation the data insdie the file will ensure conformity with the version specified here. The newly created ArxmlFile will be created with a root AUTOSAR element.

Parameters

• filename: A filename for the data from the buffer. It must be unique within the model. It will be used by write(), and is also used to identify this data in error messages.
• version: The AutosarVersion that will be used by the data created inside this file

Example

let model = AutosarModel::new();
let file = model.create_file("filename.arxml", AutosarVersion::Autosar_00050)?;

Errors

• AutosarDataError::DuplicateFilenameError: The model already contains a file with this filename

pub fn load_buffer<P: AsRef<Path>>( &self, buffer: &[u8], filename: P, strict: bool, ) -> Result<(ArxmlFile, Vec<AutosarDataError>), AutosarDataError>

Load a named buffer containing arxml data

If you have e.g. received arxml data over a network, or decompressed it from an archive, etc, then you may load it with this method.

Parameters:

• buffer: The data inside the buffer must be valid utf-8. Optionally it may begin with a UTF-8-BOM, which will be silently ignored.
• filename: the original filename of the data, or a newly generated name that is unique within the AutosarData instance.
• strict: toggle strict parsing. Some parsing errors are recoverable and can be issued as warnings.

This method may be called concurrently on multiple threads to load different buffers

Example

let model = AutosarModel::new();
model.load_buffer(buffer, "filename.arxml", true)?;

Errors

• AutosarDataError::DuplicateFilenameError: The model already contains a file with this filename
• AutosarDataError::OverlappingDataError: The new data contains Autosar paths that are already defined by the existing data
• AutosarDataError::ParserError: The parser detected an error; the source field gives further details

pub fn load_file<P: AsRef<Path>>( &self, filename: P, strict: bool, ) -> Result<(ArxmlFile, Vec<AutosarDataError>), AutosarDataError>

Load an arxml file

This function is a wrapper around load_buffer to make the common case of loading a file from disk more convenient

Parameters:

• filename: the original filename of the data, or a newly generated name that is unique within the AutosarData instance.
• strict: toggle strict parsing. Some parsing errors are recoverable and can be issued as warnings.

Example

let model = AutosarModel::new();
model.load_file("filename.arxml", true)?;

Errors

• AutosarDataError::IoErrorRead: There was an error while reading the file
• AutosarDataError::DuplicateFilenameError: The model already contains a file with this filename
• AutosarDataError::OverlappingDataError: The new data contains Autosar paths that are already defined by the existing data
• AutosarDataError::ParserError: The parser detected an error; the source field gives further details

pub fn remove_file(&self, file: &ArxmlFile)

remove a file from the model

Parameters:

• file: The file that will be removed from the model

Example

let model = AutosarModel::new();
let file = model.create_file("filename.arxml", AutosarVersion::Autosar_00050)?;
model.remove_file(&file);

pub fn serialize_files(&self) -> HashMap<PathBuf, String>

serialize each of the files in the model

returns the result in a HashMap of <file_name, file_content>

Example

let model = AutosarModel::new();
for (pathbuf, file_content) in model.serialize_files() {
    // do something with it
}

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

write all files in the model

This is a wrapper around serialize_files. The current filename of each file will be used to write the serialized data.

If any of the individual files cannot be written, then write() will abort and return the error. This may result in a situation where some files have been written and others have not.

Example

let model = AutosarModel::new();
// load or create files
model.write()?;

Errors

• AutosarDataError::IoErrorWrite: There was an error while writing a file

pub fn files(&self) -> ArxmlFileIterator

create an iterator over all ArxmlFiles in this AutosarData object

Example

let model = AutosarModel::new();
// load or create files
for file in model.files() {
    // do something with the file
}

pub fn root_element(&self) -> Element

Get a reference to the root <AUTOSAR ...> element of this model

Example

let autosar_element = model.root_element();

pub fn get_element_by_path(&self, path: &str) -> Option<Element>

get a named element by its Autosar path

This is a lookup in a hash table and runs in O(1) time

Parameters

• path: The Autosar path to look up

Example

let model = AutosarModel::new();
// [...]
if let Some(element) = model.get_element_by_path("/Path/To/Element") {
    // use the element
}

pub fn duplicate(&self) -> Result<AutosarModel, AutosarDataError>

Duplicate the model

This creates a second, fully independent model. The original model and the duplicate are not linked in any way and can be modified independently.

Example

let model = AutosarModel::new();
// [...]
let model_copy = model.duplicate()?;
assert!(model != model_copy);

Errors

• AutosarDataError::ItemDeleted: The current element is in the deleted state and will be freed once the last reference is dropped
• AutosarDataError::ParentElementLocked: a parent element was locked and did not become available after waiting briefly. The operation was aborted to avoid a deadlock, but can be retried.
• AutosarDataError::IncorrectContentType: A sub element may not be created in an element with content type CharacterData.
• AutosarDataError::ElementInsertionConflict: The requested sub element cannot be created because it conflicts with an existing sub element.
• AutosarDataError::InvalidSubElement: The ElementName is not a valid sub element according to the specification.
• AutosarDataError::NoFilesInModel: The operation cannot be completed because the model does not contain any files

pub fn elements_dfs(&self) -> ElementsDfsIterator

create a depth-first iterator over all Elements in the model

The iterator returns all elements from the merged model, consisting of data from all arxml files loaded in this model.

Directly printing the return values could show something like this:

0: AUTOSAR
1: AR-PACKAGES
2: AR-PACKAGE
...
2: AR-PACKAGE

Example

for (depth, element) in model.elements_dfs() {
    // [...]
}

pub fn elements_dfs_with_max_depth( &self, max_depth: usize, ) -> ElementsDfsIterator

Create a depth first iterator over all Elements in this model, up to a maximum depth

The iterator returns all elements from the merged model, consisting of data from all arxml files loaded in this model.

Example

for (depth, elem) in model.elements_dfs_with_max_depth(1) {
    assert!(depth <= 1);
    // ...
}

pub fn sort(&self)

Recursively sort all elements in the model. This is exactly identical to calling sort() on the root element of the model.

All sub elements of the root element are sorted alphabetically. If the sub-elements are named, then the sorting is performed according to the item names, otherwise the serialized form of the sub-elements is used for sorting.

Element attributes are not taken into account while sorting. The elements are sorted in place, and sorting cannot fail, so there is no return value.

Example

model.sort();

pub fn identifiable_elements(&self) -> IdentifiablesIterator

Create an iterator over the list of the Autosar paths of all identifiable elements

The list contains the full Autosar path of each element. It is not sorted.

Example

for (path, _) in model.identifiable_elements() {
    let element = model.get_element_by_path(&path).unwrap();
    // [...]
}

pub fn get_references_to(&self, target_path: &str) -> Vec<WeakElement>

return all elements referring to the given target path

It returns WeakElements which must be upgraded to get usable Elements.

This is effectively the reverse operation of get_element_by_path()

Parameters

• target_path: The path whose references should be returned

Example

for weak_element in model.get_references_to("/Path/To/Element") {
    // [...]
}

pub fn check_references(&self) -> Vec<WeakElement>

check all Autosar path references and return a list of elements with invalid references

For each reference: The target must exist and the DEST attribute must correctly specify the type of the target

If no references are invalid, then the return value is an empty list

Example

for broken_ref_weak in model.check_references() {
    if let Some(broken_ref) = broken_ref_weak.upgrade() {
        // update or delete ref?
    }
}

Trait Implementations

impl Clone for AutosarModel

fn clone(&self) -> AutosarModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AutosarModel

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

Formats the value using the given formatter.

impl Default for AutosarModel

fn default() -> Self

Returns the “default value” for a type.

impl Hash for AutosarModel

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AutosarModel

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for AutosarModel