Skip to content

Commit 56dd14c

Browse files
committed
docs(BFieldCodec): Mention dyn-incompatibility
1 parent bae8c29 commit 56dd14c

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

twenty-first/src/math/bfield_codec.rs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,15 @@ use super::traits::FiniteField;
1818
use crate::bfe;
1919
use crate::bfe_vec;
2020

21-
/// This trait provides functions for encoding to and decoding from a Vec of [BFieldElement]s.
22-
/// This encoding does not record the size of objects nor their type information; this is
23-
/// the responsibility of the decoder.
21+
/// This trait provides functions for encoding to and decoding from a Vec of
22+
/// [BFieldElement]s. This encoding does not record the size of objects nor
23+
/// their type information; this is the responsibility of the decoder.
24+
///
25+
/// ### Dyn-Compatibility
26+
///
27+
/// This trait is _not_ [dyn-compatible] (previously known as “object safe”).
28+
///
29+
/// [dyn-compatible]: https://doc.rust-lang.org/reference/items/traits.html#dyn-compatibility
2430
pub trait BFieldCodec {
2531
type Error: Into<Box<dyn Error + Send + Sync>> + Debug + Display;
2632

0 commit comments

Comments
 (0)