Skip to content
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

Improve Documentation RE supported types #85

Open
drewm1980 opened this issue Feb 26, 2021 · 1 comment
Open

Improve Documentation RE supported types #85

drewm1980 opened this issue Feb 26, 2021 · 1 comment
Labels
docs Documentation improvements

Comments

@drewm1980
Copy link

Is BBQueue limited to buffering bytes? If so (and I think it is), it's an important limitation to mention in the top-level README. I somehow made it through the video, the blog post, the readme, and halfway through intergrating bbqueue into my code before I discovered the bound:

impl<'a, N> BBBuffer<N>
where
    N: ArrayLength<u8>,

, figured out where ArrayLength came from, studied the generic_array crate a bit, and realized bbqueue probably isn't what I was looking for. I knew bbqueue was implemented for byte buffer DMA use cases, but I'm so used to containers being generic over the contained type that I mistakenly assumed it.

Thanks! Andrew

@jamesmunns
Copy link
Owner

Hey Andrew,

For a variety of reasons, bbqueue only handles u8s. This is largely due to the ability to avoid things like alignment or other issues.

If this is a problem, I'd probably suggest checking out heapless's Queue structures (spsc or mpmc).

I'll leave this issue open as a reminder to update the docs to make this more clear!

@Sympatron Sympatron added the docs Documentation improvements label Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements
Projects
None yet
Development

No branches or pull requests

3 participants