Skip to content

Add basic AssocArraySize docs #96

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.

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

Merged
merged 1 commit into from
Oct 19, 2024
Merged
Changes from all commits
Commits
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
17 changes: 16 additions & 1 deletion src/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,22 @@ pub unsafe trait ArraySize: Unsigned {
+ IntoIterator<Item = T>;
}

/// Associates an [`ArraySize`] with a given type.
/// Associates an [`ArraySize`] with a given type. Can be used to write APIs which use `[T; N]`
/// and convert to [`Array`] internally.
///
/// # Example
///
/// ```
/// use hybrid_array::{ArrayN, AssocArraySize};
///
/// pub fn example<const N: usize>(bytes: &[u8; N])
/// where
/// [u8; N]: AssocArraySize + AsRef<ArrayN<u8, N>>
/// {
/// // _arrayn is ArrayN<u8, N>
/// let _arrayn = bytes.as_ref();
/// }
/// ```
pub trait AssocArraySize: Sized {
/// Size of an array type, expressed as a [`typenum`]-based [`ArraySize`].
type Size: ArraySize;
Expand Down