Skip to content

Add public constructors for SizeError and ValidityError #3678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
barunaniket wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add public constructors for SizeError and ValidityError #3678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
407d5d3
Add public constructors for SizeError and ValidityError
barunaniket Sep 12, 2026
4b8e24c
Update UI test stderr snapshots for shifted error.rs line numbers
barunaniket Sep 12, 2026
a2fd6bd
Fix remaining stale line number in UI test stderr snapshots
barunaniket Sep 12, 2026
ad8d743
Merge branch 'main' into size-error-constructor
barunaniket Sep 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions zerocopy/src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,23 @@ pub struct SizeError<Src, Dst: ?Sized> {
}

impl<Src, Dst: ?Sized> SizeError<Src, Dst> {
pub(crate) fn new(src: Src) -> Self {
/// Constructs a new `SizeError`.
///
/// This can be used to propagate a size error out of code which knows,
/// out-of-band, that a conversion would fail due to an incorrect source
/// size, without needing to actually perform a failing conversion just to
/// obtain the error.
///
/// # Examples
///
/// ```
/// use zerocopy::error::{ConvertError, SizeError};
///
/// let err: SizeError<(), u32> = SizeError::new(());
/// let err: ConvertError<(), SizeError<(), u32>, ()> = err.into();
/// ```
#[inline]
pub fn new(src: Src) -> Self {
Self { src, _dst: SendSyncPhantomData::default() }
}

Expand Down Expand Up @@ -595,7 +611,24 @@ pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
}

impl<Src, Dst: ?Sized + TryFromBytes> ValidityError<Src, Dst> {
pub(crate) fn new(src: Src) -> Self {
/// Constructs a new `ValidityError`.
///
/// This can be used to propagate a validity error out of code which
/// knows, out-of-band, that a conversion would fail due to invalid
/// source data, without needing to actually perform a failing conversion
/// just to obtain the error.
///
/// # Examples
///
/// ```
/// use zerocopy::error::{ConvertError, ValidityError};
/// use zerocopy::FromBytes;
///
/// let err: ValidityError<(), bool> = ValidityError::new(());
/// let err: ConvertError<(), (), ValidityError<(), bool>> = err.into();
/// ```
#[inline]
pub fn new(src: Src) -> Self {
Self { src, _dst: SendSyncPhantomData::default() }
}

Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute.msrv.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
| ^^^^^^^^^^^^^^^^^^^^^^ the trait `TryFromBytes` is not implemented for `NotZerocopy`
|
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`

error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
Expand All @@ -30,9 +30,9 @@ error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
| ^^^^^^^^^^^^^^^^^^^^^^^ the trait `TryFromBytes` is not implemented for `NotZerocopy`
|
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: this error originates in the macro `try_transmute` (in Nightly builds, run with -Z macro-backtrace for more info)

Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute.nightly.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> src/error.rs:590:45
--> src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down Expand Up @@ -85,9 +85,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> src/error.rs:590:45
--> src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute.stable.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down Expand Up @@ -85,9 +85,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute_mut.msrv.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `TryFromBytes` is not implemented for `NotZerocopy`
|
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`

error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
Expand All @@ -33,9 +33,9 @@ error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
| ^^^^^^^^^^^^^^^^^^^^^^^ the trait `TryFromBytes` is not implemented for `NotZerocopy`
|
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: this error originates in the macro `try_transmute_mut` (in Nightly builds, run with -Z macro-backtrace for more info)

Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute_mut.nightly.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> src/error.rs:590:45
--> src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down Expand Up @@ -117,9 +117,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> src/error.rs:590:45
--> src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute_mut.stable.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down Expand Up @@ -117,9 +117,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute_ref.msrv.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
| ^^^^^^^^^^^^^^^^^^^^^^^ the trait `TryFromBytes` is not implemented for `NotZerocopy`
|
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`

error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
Expand All @@ -56,9 +56,9 @@ error[E0277]: the trait bound `NotZerocopy: TryFromBytes` is not satisfied
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `TryFromBytes` is not implemented for `NotZerocopy`
|
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: this error originates in the macro `try_transmute_ref` (in Nightly builds, run with -Z macro-backtrace for more info)

Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute_ref.nightly.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> src/error.rs:590:45
--> src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down Expand Up @@ -136,9 +136,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> src/error.rs:590:45
--> src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down
8 changes: 4 additions & 4 deletions zerocopy/tests/ui/try_transmute_ref.stable.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down Expand Up @@ -136,9 +136,9 @@ help: the trait `TryFromBytes` is not implemented for `NotZerocopy`
(A, B, C, D, E, F, G, H)
and $OTHER_TYPES others
note: required by a bound in `ValidityError`
--> $WORKSPACE/src/error.rs:590:45
--> $WORKSPACE/src/error.rs:606:45
|
590 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
606 | pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
| ^^^^^^^^^^^^ required by this bound in `ValidityError`
= note: the full name for the type has been written to '/long-type-HASH.txt'
= note: consider using `--verbose` to print the full type name to the console
Expand Down
Loading