Skip to content

Commit

Permalink
ParseOptions: Add a note about alloc limits being retained
Browse files Browse the repository at this point in the history
  • Loading branch information
Serial-ATA committed Oct 23, 2023
1 parent fc9877a commit e575675
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/probe.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,9 @@ impl ParseOptions {
/// This is a safety measure to prevent allocating too much memory for a single tag item. If a tag item
/// exceeds this limit, the allocator will return [`crate::error::ErrorKind::TooMuchData`].
///
/// NOTE: This only needs to be set once per thread. The limit will be used for all subsequent
/// reads, until a new one is set.
///
/// # Examples
///
/// ```rust
Expand Down

0 comments on commit e575675

Please sign in to comment.