Skip to main content

vin_decode/
lib.rs

1//! Auto-updating VIN decoder backed by the NHTSA vPIC database.
2//!
3//! This crate ships pre-built FST/rkyv lookup maps that get refreshed monthly
4//! from the official NHTSA vPIC dump via CI. End users get fresh decoder data
5//! without ever touching the network at runtime.
6//!
7//! # Example
8//!
9//! ```no_run
10//! use vin_decode::Decoder;
11//!
12//! let dec = Decoder::new()?;
13//! let v = dec.decode("1HGCM82633A004352")?;
14//! assert_eq!(v.make.as_deref(), Some("Honda"));
15//! # Ok::<(), vin_decode::Error>(())
16//! ```
17
18#![deny(missing_docs)]
19
20#[cfg(feature = "build")]
21pub mod build;
22
23pub mod data;
24
25pub(crate) mod maps;
26
27mod catalog;
28mod check_digit;
29mod country;
30mod decoder;
31mod element;
32mod error;
33mod pattern;
34mod types;
35mod wmi;
36mod year;
37
38#[cfg(feature = "embedded")]
39mod embedded;
40
41pub use catalog::Catalog;
42pub use country::country_from_code;
43pub use data::{EngineRow, EuModelRow};
44pub use decoder::Decoder;
45pub use error::{Error, Result};
46pub use types::{BodyClass, FuelType, Vehicle, Vin};
47pub use wmi::region as region_from_code;
48
49#[cfg(feature = "build")]
50#[doc(hidden)]
51pub use maps::{FstMap, FstSet};
52
53use static_assertions::assert_impl_all;
54assert_impl_all!(Decoder: Send, Sync);
55assert_impl_all!(Catalog: Send, Sync);
56assert_impl_all!(Vehicle: Send, Sync);
57assert_impl_all!(Vin: Send, Sync);