Crate marker_adapter
source ·Expand description
Marker Adapter 🔌
This crate provides a common interface for drivers to communicate with lint crates for Marker. It does some heavy lifting which would otherwise need to be done by each individual driver. You’re welcome to check out Marker’s Readme if you’re interested in the project.
Warning
This crate is not part of Marker’s official API, it’s only intended to be used by drivers.
Functions
Driver -> Lint Crate Communication
The adapter can load a list of lint crates and send information from the driver to all lint crates. The adapter and API takes care of safe ABI communication between the driver and lint crates.
Lint Crate -> Driver Communication
Marker’s API requires some callbacks from the lint crates into the driver. The adapter can deal with all the ABI conversions, drivers only need to implement the DriverContext trait provided by the adapter.
Creating an adapter instance
An adapter instance can be created from the environment. For this, the following environment values are read:
MARKER_LINT_CRATES: A semicolon separated list of crate name and absolute path pairs. Each pair is internally separated by a colon.
Contributing
Contributions are highly appreciated! If you encounter any issues or have suggestions for improvements, please check out Marker’s GitHub repository.
License
Copyright (c) 2022-2023 Rust-Marker
Rust-marker is distributed under the terms of the MIT license or the Apache License (Version 2.0).
See LICENSE-APACHE, LICENSE-MIT.
Modules
- The
marker_apicrate is designed to be driver-independent and lightweight. Communication from the lint-crate to the driver is done via structs inside themarker_api::contextmodule. For example,marker_api::MarkerContext.
Structs
- This struct is the interface used by lint drivers to load lint crates, pass
marker_apiobjects to external lint passes and all other magic you can think of. - A struct describing a lint crate that can be loaded.