Struct InspectorBuilder

pub struct InspectorBuilder { /* private fields */ }

Configures and builds an instance of Inspector.

Fields

sources

List of paths to directories with MAVLink XML definitions. Use InspectorBuilder::set_sources to set sources or InspectorBuilder::add_source to push singe source location.

include / exclude

Define:

• include: InspectorBuilder::set_include
• exclude: InspectorBuilder::set_exclude

These fields specify which dialects will be added. Exclusion/inclusion rules will be applied only to the first level of dialects. Which means that if dialect X has dialect Y as a dependency, then Y will be loaded and parsed even if explicitly excluded.

If both include and exclude are set, then includes will have precedence over exclusion list. Which means that dialects will be excluded within the list of explicitly specified dialects.

Implementations

impl InspectorBuilder

pub fn build(&self) -> Result<Inspector>

Load an instance of Inspector.

Loads a collection of DialectXmlDefinition in the process.

Errors

• Returns variants of Error if XML definitions discovery fails.
• In the case of dialect naming collision returns XmlInspectionError::NamingCollision.

pub fn set_sources<T>(&mut self, sources: &[T]) -> &mut Self

where T: Into<PathBuf> + Clone,

Sets source paths.

Each sources item is a path to a directory containing MAVLink XML definitions.

pub fn add_source<T>(&mut self, source: T) -> &mut Self

where T: Into<PathBuf> + Clone,

Adds source path.

Adds path to a directory containing MAVLink XML definitions.

pub fn set_include<T: ?Sized + ToString>( &mut self, dialect_names: &[&T], ) -> &mut Self

Sets the list of dialect names to include.

Names will be transformed to Dialect::canonical_name upon matching.

pub fn set_exclude<T: ?Sized + ToString>( &mut self, dialect_names: &[&T], ) -> &mut Self

Sets the list of dialect names to exclude.

Names will be transformed to Dialect::canonical_name upon matching.

Trait Implementations

impl Clone for InspectorBuilder

fn clone(&self) -> InspectorBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InspectorBuilder

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

Formats the value using the given formatter.

impl Default for InspectorBuilder

fn default() -> InspectorBuilder

Returns the “default value” for a type.