Improve documentation on UndefinedBehaviorInfo::ValidationFailure

This commit is contained in:
Rémy Rakic 2021-06-14 18:57:06 +02:00
parent b87724053e
commit 19fddc019f

View file

@ -257,6 +257,8 @@ pub enum UndefinedBehaviorInfo<'tcx> {
/// Should only be thrown by `validity.rs` and always point out which part of the value /// Should only be thrown by `validity.rs` and always point out which part of the value
/// is the problem. /// is the problem.
ValidationFailure { ValidationFailure {
/// The "path" to the value in question, e.g. `.0[5].field` for a struct
/// field in the 6th element of an array that is the first element of a tuple.
path: Option<String>, path: Option<String>,
msg: String, msg: String,
}, },