Краткая шпаргалка

Краткая справка по всем 14+ паттернам корректности по построению с блок-схемой выбора, каталогом паттернов, правилами композиции, сопоставлением с крейтами и шпаргалкой по гарантиям на уровне типов.

Перекрёстные ссылки: все главы: это таблица для поиска по всей книге.

Краткая справка: паттерны корректности по построению

Руководство по выбору паттерна

Ошибка катастрофична, если её пропустить?
├── Да → Её можно закодировать в типах?
│         ├── Да → ИСПОЛЬЗУЙТЕ КОРРЕКТНОСТЬ ПО ПОСТРОЕНИЮ
│         └── Нет → Проверка во время выполнения + обширное тестирование
└── Нет → Проверка во время выполнения подойдёт

Каталог паттернов

№	Паттерн	Ключевой трейт/тип	Предотвращает	Стоимость во время выполнения	Глава
1	Типизированные команды	`trait IpmiCmd { type Response; }`	Неверный тип ответа	Нулевая	гл. 02
2	Одноразовые типы	`struct Nonce` (не Clone/Copy)	Повторное использование nonce/ключа	Нулевая	гл. 03
3	Capability-токены	`struct AdminToken { _private: () }`	Несанкционированный доступ	Нулевая	гл. 04
4	Typestate	`Session<Active>`	Нарушения протокола	Нулевая	гл. 05
5	Размерные типы	`struct Celsius(f64)`	Путаница единиц	Нулевая	гл. 06
6	Проверенные границы	`struct ValidFru` (через TryFrom)	Использование непроверенных данных	Разбор один раз	гл. 07
7	Capability-миксины	`trait FanDiagMixin: HasSpi + HasI2c`	Отсутствие доступа к шине	Нулевая	гл. 08
8	Phantom-типы	`Register<Width16>`	Несоответствие ширины/направления	Нулевая	гл. 09
9	Sentinel → Option	`Option<u8>` (не `0xFF`)	Ошибки «sentinel как значение»	Нулевая	гл. 11
10	Sealed-трейты	`trait Cmd: private::Sealed`	Небезопасные внешние реализации	Нулевая	гл. 11
11	Non-exhaustive enum	`#[non_exhaustive] enum Sku`	Тихое проваливание в match	Нулевая	гл. 11
12	Билдер с typestate	`DerBuilder<Set, Missing>`	Неполное создание объекта	Нулевая	гл. 11
13	Валидация через FromStr	`impl FromStr for DiagLevel`	Непроверенный строковый ввод	Разбор один раз	гл. 11
14	Размер через const-обобщения	`RegisterBank<const N: usize>`	Несоответствие размера буфера	Нулевая	гл. 11
15	Безопасная обёртка `unsafe`	`MmioRegion::read_u32()`	Непроверенный MMIO/FFI	Нулевая	гл. 11
16	Async typestate	`AsyncSession<Active>`	Нарушения async-протокола	Нулевая	гл. 11
17	Const-утверждения	`SdrSensorId<const N: u8>`	Недопустимые ID на этапе компиляции	Нулевая	гл. 11
18	Сессионные типы	`Chan<SendRequest>`	Операции с каналом не по порядку	Нулевая	гл. 11
19	Самоссылочный Pin	`Pin<Box<StreamParser>>`	Висячий внутренний указатель	Нулевая	гл. 11
20	RAII / Drop	`impl Drop for Session`	Утечка ресурса при любом пути выхода	Нулевая	гл. 11
21	Иерархия типов ошибок	`#[derive(Error)] enum DiagError`	Тихое проглатывание ошибок	Нулевая	гл. 11
22	`#[must_use]`	`#[must_use] struct Token`	Тихо отброшенные значения	Нулевая	гл. 11

Правила композиции

Capability-токен + Typestate = Авторизованные переходы состояний
Типизированная команда + Размерный тип = Физически типизированные ответы
Проверенная граница + Phantom-тип = Типизированный доступ к регистрам по проверенной конфигурации
Capability-миксин + Типизированная команда = Типизированные операции с учётом шин
Одноразовый тип + Typestate = Протоколы «потребляется при переходе»
Sealed-трейт + Типизированная команда = Закрытый, корректный набор команд
Sentinel → Option + Проверенная граница = Чистый конвейер «разбор один раз»
Билдер с typestate + Capability-токен = Доказательство полного создания
FromStr + #[non_exhaustive] = Развиваемый разбор enum с быстрым отказом
Размер через const-обобщения + Проверенная граница = Размерные, проверенные протокольные буферы
Безопасная обёртка unsafe + Phantom-тип = Типизированный и безопасный доступ к MMIO
Async typestate + Capability-токен = Авторизованные async-переходы
Сессионные типы + Типизированная команда = Полностью типизированные каналы «запрос — ответ»
Pin + Typestate = Самоссылочные автоматы состояний, которые не могут переместиться
RAII (Drop) + Typestate = Гарантии очистки, зависящей от состояния
Иерархия ошибок + Проверенная граница = Типизированные ошибки разбора с исчерпывающей обработкой
#[must_use] + Одноразовый тип = Токены, которые трудно игнорировать и трудно переиспользовать

Антипаттерны, которых следует избегать

Антипаттерн	Почему это неверно	Правильная альтернатива
`fn read_sensor() -> f64`	Без единиц: может быть °C, °F или об/мин	`fn read_sensor() -> Celsius`
`fn encrypt(nonce: &[u8; 12])`	Nonce можно переиспользовать (заимствование)	`fn encrypt(nonce: Nonce)` (перемещение)
`fn admin_op(is_admin: bool)`	Вызывающий может соврать (`true`)	`fn admin_op(_: &AdminToken)`
`fn send(session: &Session)`	Нет гарантии состояния	`fn send(session: &Session<Active>)`
`fn process(data: &[u8])`	Не проверено	`fn process(data: &ValidFru)`
`Clone` для эфемерных ключей	Сводит на нет гарантию одноразовости	Не выводите Clone
`let vendor_id: u16 = 0xFFFF`	Sentinel хранится внутри	`let vendor_id: Option<u16> = None`
`fn route(level: &str)` с запасным вариантом	Опечатки тихо заменяются значением по умолчанию	`let level: DiagLevel = s.parse()?`
`Builder::new().finish()` без полей	Создаётся неполный объект	Билдер с typestate: `finish()` открывается при `Set`
`let buf: Vec<u8>` для аппаратного буфера фиксированного размера	Размер проверяется только во время выполнения	`RegisterBank<4096>` (const-обобщение)
Разбросанный сырой `unsafe { ptr::read(...) }`	Риск UB, не поддаётся аудиту	`MmioRegion::read_u32()`: безопасная обёртка
`async fn transition(&mut self)`	Изменяемые заимствования не обеспечивают состояние	`async fn transition(self) -> NextState`
`fn cleanup()`, вызываемая вручную	Забывается при раннем возврате или панике	`impl Drop`: компилятор вставляет вызов
`fn op() -> Result<T, String>`	Непрозрачная ошибка, нельзя сопоставить варианты	`fn op() -> Result<T, DiagError>`: enum

Сопоставление с кодовой базой диагностики

Модуль	Применимые паттерны
`protocol_lib`	Типизированные команды, сессии с typestate
`thermal_diag`	Capability-миксины, размерные типы
`accel_diag`	Проверенные границы, phantom-регистры
`network_diag`	Typestate (обучение линка), capability-токены
`pci_topology`	Phantom-типы (ширина регистра), проверенная конфигурация, sentinel → Option
`event_handler`	Одноразовые токены аудита, capability-токены, FromStr (Component)
`event_log`	Проверенные границы (разбор записей SEL)
`compute_diag`	Размерные типы (температура, частота)
`memory_diag`	Проверенные границы (данные SPD), размерные типы
`switch_diag`	Typestate (перечисление портов), phantom-типы
`config_loader`	FromStr (DiagLevel, FaultStatus, DiagAction)
`log_analyzer`	Проверенные границы (CompiledPatterns)
`diag_framework`	Билдер с typestate (DerBuilder), сессионные типы (оркестратор ↔ воркер)
`topology_lib`	Const-обобщённые банки регистров, безопасные обёртки MMIO

Типы как гарантии — краткое соответствие

Гарантия	Эквивалент в Rust	Пример
«Это доказательство существует»	Тип	`AdminToken`
«У меня есть доказательство»	Значение этого типа	`let tok = authenticate()?;`
«A влечёт B»	Функция `fn(A) -> B`	`fn activate(AdminToken) -> Session<Active>`
«И A, и B»	Кортеж `(A, B)` или несколько параметров	`fn op(a: &AdminToken, b: &LinkTrained)`
«Либо A, либо B»	`enum { A(A), B(B) }` или `Result<A, B>`	`Result<Session<Active>, Error>`
«Всегда истинно»	`()` (тип unit)	Всегда конструируется
«Невозможно»	`!` (тип never) или `enum Void {}`	Никогда не может быть сконструирована

Keyboard shortcuts

Корректность на уровне типов в Rust