Приложение C: Выводимые трейты
В различных местах книги обсуждался атрибут derive, который
можно применять к определению структуры или перечисления. Атрибут derive генерирует
код, реализующий трейт с собственной реализацией по умолчанию для
типа, аннотированного синтаксисом derive.
В этом приложении приводится справочник всех трейтов в стандартной
библиотеке, которые можно использовать с derive. Каждый раздел охватывает:
- Какие операторы и методы включает производный трейт
- Что делает реализация трейта, предоставляемая
derive - Что означает реализация трейта для типа
- Условия, при которых разрешено или не разрешено реализовывать трейт
- Примеры операций, требующих этот трейт
Если требуется поведение, отличное от предоставляемого атрибутом derive,
следует обратиться к документации стандартной библиотеки
для каждого трейта, чтобы узнать подробности о ручной реализации.
Перечисленные здесь трейты — единственные, определённые стандартной библиотекой, которые
можно реализовать для своих типов с помощью derive. Другие трейты, определённые в
стандартной библиотеке, не имеют разумного поведения по умолчанию, поэтому их реализация
остаётся на усмотрение разработчика в соответствии с тем, чего он пытается достичь.
Примером трейта, который нельзя вывести, является Display, отвечающий
за форматирование для конечных пользователей. Всегда следует продумывать подходящий способ
отображения типа конечному пользователю. Какие части типа конечный пользователь должен
видеть? Какие части покажутся ему релевантными? Какой формат данных
будет для него наиболее удобным? Компилятор Rust не обладает этим пониманием, поэтому
не может предоставить подходящее поведение по умолчанию.
Список производных трейтов, приведённый в этом приложении, не является исчерпывающим:
библиотеки могут реализовывать derive для собственных трейтов, делая список
трейтов, которые можно использовать с derive, поистине открытым. Реализация derive
включает использование процедурного макроса, который рассматривается в разделе «Пользовательские макросы derive» главы 20.
Debug для вывода программиста
Трейт Debug включает отладочное форматирование в строках формата, которое
указывается добавлением :? внутри заполнителей {}.
Трейт Debug позволяет выводить экземпляры типа в целях отладки,
чтобы вы и другие программисты, использующие ваш тип, могли исследовать экземпляр
в определённой точке выполнения программы.
Трейт Debug требуется, например, при использовании макроса assert_eq!.
Этот макрос выводит значения экземпляров, переданных в качестве аргументов, если
проверка на равенство не удалась, чтобы программисты могли увидеть, почему два экземпляра
не равны.
PartialEq и Eq для сравнения на равенство
Трейт PartialEq позволяет сравнивать экземпляры типа для проверки на
равенство и включает использование операторов == и !=.
Вывод PartialEq реализует метод eq. Когда PartialEq выводится для
структур, два экземпляра равны только если все поля равны, и
экземпляры не равны, если любое из полей не равно. Когда выводится для перечислений,
каждый вариант равен самому себе и не равен другим вариантам.
Трейт PartialEq требуется, например, при использовании
макроса assert_eq!, которому нужна возможность сравнивать два экземпляра типа
на равенство.
Трейт Eq не имеет методов. Его назначение — сигнализировать, что для каждого значения
аннотированного типа значение равно самому себе. Трейт Eq можно применять
только к типам, которые также реализуют PartialEq, хотя не все типы,
реализующие PartialEq, могут реализовать Eq. Один из примеров — типы
чисел с плавающей точкой: реализация чисел с плавающей точкой утверждает, что два
экземпляра значения «не-число» (NaN) не равны друг другу.
Примером необходимости Eq является использование ключей в HashMap<K, V>, чтобы
HashMap<K, V> мог определить, являются ли два ключа одинаковыми.
PartialOrd и Ord для сравнения порядка
Трейт PartialOrd позволяет сравнивать экземпляры типа для целей сортировки.
Тип, реализующий PartialOrd, можно использовать с операторами <, >,
<= и >=. Трейт PartialOrd можно применять только к типам,
которые также реализуют PartialEq.
Вывод PartialOrd реализует метод partial_cmp, который возвращает
Option<Ordering>, значение None в случае, когда заданные значения не создают
упорядочение. Примером значения, которое не создаёт упорядочение, хотя
большинство значений этого типа можно сравнивать, является значение с плавающей точкой NaN.
Вызов partial_cmp с любым числом с плавающей точкой и значением
NaN с плавающей точкой вернёт None.
Когда PartialOrd выводится для структур, он сравнивает два экземпляра путём сравнения
значения в каждом поле в порядке их появления в определении структуры.
Когда PartialOrd выводится для перечислений, варианты перечисления, объявленные раньше в
определении перечисления, считаются меньшими, чем варианты, объявленные позже.
Трейт PartialOrd требуется, например, для метода gen_range
из крейта rand, который генерирует случайное значение в диапазоне, заданном
выражением диапазона.
Трейт Ord позволяет утверждать, что для любых двух значений аннотированного
типа существует допустимое упорядочение. Трейт Ord реализует метод cmp,
который возвращает Ordering, а не Option<Ordering>, поскольку допустимое
упорядочение всегда возможно. Трейт Ord можно применять только к типам,
которые также реализуют PartialOrd и Eq (а Eq требует PartialEq). Когда
Ord выводится для структур и перечислений, cmp ведёт себя так же, как производная
реализация partial_cmp для PartialOrd.
Примером необходимости Ord является хранение значений в BTreeSet<T>,
структуре данных, которая хранит данные на основе порядка сортировки значений.
Clone и Copy для дублирования значений
Трейт Clone позволяет явно создавать глубокую копию значения, и
процесс дублирования может включать выполнение произвольного кода и копирование данных в куче.
См. раздел «Взаимодействие переменных и данных при клонировании» главы 4 для получения дополнительной информации о Clone.
Вывод Clone реализует метод clone, который при реализации для
всего типа вызывает clone для каждой из частей типа. Это означает, что все
поля или значения в типе также должны реализовывать Clone для вывода Clone.
Примером необходимости Clone является вызов метода to_vec для
среза. Срез не владеет экземплярами типа, которые он содержит, но вектор,
возвращаемый to_vec, должен владеть своими экземплярами, поэтому to_vec вызывает
clone для каждого элемента. Таким образом, тип, хранящийся в срезе, должен реализовывать Clone.
Трейт Copy позволяет дублировать значение только путём копирования битов, хранящихся в
стеке; произвольный код не требуется. См. раздел «Данные только в стеке:
Copy» главы 4 для получения дополнительной
информации о Copy.
Трейт Copy не определяет никаких методов, чтобы программисты не могли
переопределить эти методы и нарушить предположение о том, что произвольный код
не выполняется. Таким образом, все программисты могут предполагать, что копирование значения будет
очень быстрым.
Можно выводить Copy для любого типа, все части которого реализуют Copy. Тип, который
реализует Copy, также должен реализовывать Clone, поскольку тип, реализующий
Copy, имеет тривиальную реализацию Clone, которая выполняет ту же задачу, что и
Copy.
Трейт Copy требуется редко; типы, реализующие Copy, имеют
доступные оптимизации, означающие, что не нужно вызывать clone, что делает
код более кратким.
Всё, что возможно с Copy, также можно выполнить с Clone, но код
может быть медленнее или требовать использования clone в некоторых местах.
Hash для отображения значения в значение фиксированного размера
Трейт Hash позволяет взять экземпляр типа произвольного размера и
отобразить этот экземпляр в значение фиксированного размера с помощью хеш-функции. Вывод
Hash реализует метод hash. Производная реализация метода hash
объединяет результат вызова hash для каждой из частей типа,
что означает, что все поля или значения также должны реализовывать Hash для вывода Hash.
Примером необходимости Hash является хранение ключей в HashMap<K, V>
для эффективного хранения данных.
Default для значений по умолчанию
Трейт Default позволяет создать значение по умолчанию для типа. Вывод
Default реализует функцию default. Производная реализация функции
default вызывает функцию default для каждой части типа,
что означает, что все поля или значения в типе также должны реализовывать Default для
вывода Default.
Функция Default::default обычно используется в сочетании с синтаксисом обновления структуры,
рассмотренным в разделе «Создание экземпляров из других экземпляров с помощью
синтаксиса обновления структуры» главы 5. Можно настроить несколько полей структуры и
затем установить и использовать значение по умолчанию для остальных полей, используя
..Default::default().
Трейт Default требуется при использовании метода unwrap_or_default для
экземпляров Option<T>, например. Если Option<T> равно None, метод
unwrap_or_default вернёт результат Default::default для типа
T, хранящегося в Option<T>.