Skip to content

Commit

Permalink
doc: clarify where to get a ConstToken
Browse files Browse the repository at this point in the history
  • Loading branch information
meithecatte committed Feb 5, 2024
1 parent 2ddeac7 commit b48726f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/const_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ use core::marker::PhantomData;
///
/// Some `const fn`s in this crate will need an instance of this type
/// for some type-level information usually provided by traits.
///
/// A token can be obtained from [`BitFlags::CONST_TOKEN`]. The relevant types
/// should be readily inferred from context.
///
/// For an example of usage, see [`not_c`][BitFlags::not_c].
pub struct ConstToken<T, N>(BitFlags<T, N>);

Expand Down

0 comments on commit b48726f

Please sign in to comment.