Skip to content

Commit

Permalink
[error] Document validation order (#1456)
Browse files Browse the repository at this point in the history
Makes progress on #1331
  • Loading branch information
joshlf committed Jun 24, 2024
1 parent ea1441f commit 1bf5d4a
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/error.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
// Copyright 2024 The Fuchsia Authors
//
// Licensed under the 2-Clause BSD License <LICENSE-BSD or
// https://opensource.org/license/bsd-2-clause>, Apache License, Version 2.0
// <LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0>, or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your option.
// This file may not be copied, modified, or distributed except according to
// those terms.

//! Types related to error reporting.
//!
//! ## Single failure mode errors
Expand All @@ -22,6 +31,12 @@
//!
//! All error types provide an `into_src` method that converts the error into
//! the source value underlying the failed conversion.
//!
//! ## Validation order
//!
//! Our conversion methods typically check alignment, then size, then bit
//! validity. However, we do not guarantee that this is always the case, and
//! this behavior may change between releases.

use core::{convert::Infallible, fmt, marker::PhantomData, ops::Deref};

Expand Down

0 comments on commit 1bf5d4a

Please sign in to comment.