Skip to main content

Crate maliput_sdk

Crate maliput_sdk 

Source
Expand description

§maliput-sdk

github crates.io docs.rs build status

Brings maliput binaries to Rust land.

Note: What is maliput? Refer to https://maliput.readthedocs.org.

§Prerequisites

  • OS: Ubuntu 20.04
  • Bazel 7.5.0

§Description

maliput-sdk package relies on maliput releases on the BCR.

BCR ModuleCurrent version
maliput1.14.0
maliput_malidrive0.19.0
maliput_geopackage0.1.0

§Features

Backends are exposed as Cargo features:

FeatureDefaultDescription
maliput_malidriveOpenDRIVE (.xodr) backend
maliput_geopackageGeoPackage (.gpkg) backend
allEnables both backends
# Default (maliput_malidrive only)
cargo build

# Both backends
cargo build --features all

# Only maliput_geopackage
cargo build --no-default-features --features maliput_geopackage

§Usage

This package brings the maliput ecosystem and provides the path to where the installation is located.

  • For accessing it via build.rs file, some env vars are provided (always available):
    • DEP_MALIPUT_SDK_BIN_PATH: Path to maliput-sdk’s bazel binaries.
    • DEP_MALIPUT_SDK_MALIPUT_BIN_PATH: Path to maliput binaries.
    • DEP_MALIPUT_SDK_ROOT: Path to the build output root.
    • DEP_MALIPUT_SDK_SDK_LIB_NAME: Name of the SDK shared library (varies by features).
  • Conditional on maliput_malidrive feature:
    • DEP_MALIPUT_SDK_MALIPUT_MALIDRIVE_BIN_PATH: Path to maliput_malidrive binaries.
    • DEP_MALIPUT_SDK_MALIPUT_MALIDRIVE_PLUGIN_PATH: Path to maliput_malidrive road network plugin.
  • Conditional on maliput_geopackage feature:
    • DEP_MALIPUT_SDK_MALIPUT_GEOPACKAGE_BIN_PATH: Path to maliput_geopackage binaries.
    • DEP_MALIPUT_SDK_MALIPUT_GEOPACKAGE_PLUGIN_PATH: Path to maliput_geopackage road network plugin.
  • For accessing it via a library:
    • maliput_sdk::sdk_libraries — Returns vendored library paths.
    • maliput_sdk::sdk_resources — Returns vendored resource paths.
    • maliput_sdk::get_maliput_malidrive_plugin_path(requires feature maliput_malidrive)
    • maliput_sdk::get_maliput_geopackage_plugin_path(requires feature maliput_geopackage)

§Executables

  • Print libraries being vendored
    cargo run --bin maliput-sdk

§License

Licensed under BSD 3-Clause.

Functions§

get_maliput_malidrive_plugin_path
Returns the path to the maliput_malidrive plugin.
sdk_libraries
Returns a map of libraries here vendored and the directories to search for the binaries.
sdk_resources
Returns a map of resources here vendored and the directories to search for the resources.