Skip to content

Rename LayoutVerified to Ref#203

Merged
joshlf merged 1 commit intomainfrom
rename-lv-ref
Aug 2, 2023
Merged

Rename LayoutVerified to Ref#203
joshlf merged 1 commit intomainfrom
rename-lv-ref

Conversation

@joshlf
Copy link
Member

@joshlf joshlf commented Jul 29, 2023

While LayoutVerified is technically a descriptive name, it doesn't give much of a hint as to what the type's intended use is. The way it is used in practice is as a sort of "smart" reference - the only difference from a native reference (& or &mut) is that it is generic over the mutability of the byte slice from which it was constructed. Thus, Ref is a more helpful and informative name.

Closes #68

cc @kupiakos

While `LayoutVerified` is technically a descriptive name, it doesn't
give much of a hint as to what the type's intended use is. The way it is
used in practice is as a sort of "smart" reference - the only difference
from a native reference (`&` or `&mut`) is that it is generic over the
mutability of the byte slice from which it was constructed. Thus, `Ref`
is a more helpful and informative name.

Closes #68
@joshlf joshlf requested a review from djkoloski July 29, 2023 11:30
Copy link
Member

@djkoloski djkoloski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@joshlf joshlf merged commit 1dbc61d into main Aug 2, 2023
@joshlf joshlf deleted the rename-lv-ref branch August 2, 2023 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename LayoutVerified to Ref

2 participants