harald/wyoming-whisper-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add docs to get_token and its unchecked variant

Browse source
This commit is contained in:
Niko 2025-08-13 00:53:44 -07:00
parent e34533731c
commit 7e46c91cbd
No known key found for this signature in database
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/whisper_state/segment.rs
View file

@ -153,13 +153,18 @@ impl<'a> WhisperSegment<'a> {
token_idx >= 0 && token_idx < self.token_count token_idx >= 0 && token_idx < self.token_count
} }
/// Get the token at the specified index. Returns `None` if out of bounds for this state.
pub fn get_token(&self, token: c_int) -> Option<WhisperToken<'_, '_>> { pub fn get_token(&self, token: c_int) -> Option<WhisperToken<'_, '_>> {
self.token_in_bounds(token) self.token_in_bounds(token)
// SAFETY: we've just asserted that this token is in bounds
.then(|| unsafe { WhisperToken::new_unchecked(self, token) }) .then(|| unsafe { WhisperToken::new_unchecked(self, token) })
} }
/// The same as [`Self::get_token`] but without any bounds check.
///
/// # Safety /// # Safety
/// You must ensure `token` is in bounds for this [`WhisperSegment`]. /// You must ensure `token` is in bounds for this [`WhisperSegment`].
/// If it is not, this is immediate Undefined Behaviour.
pub unsafe fn get_token_unchecked(&self, token: c_int) -> WhisperToken<'_, '_> { pub unsafe fn get_token_unchecked(&self, token: c_int) -> WhisperToken<'_, '_> {
WhisperToken::new_unchecked(self, token) WhisperToken::new_unchecked(self, token)
} }