Skip to content

Commit 2f855ce

Browse files
committed
Mark MetricFunctionPtr as doc(hidden)
It has to be pub since it's exposed through the public VectorType trait, but details of how FFI calls, trampolines etc are handled probably shouldn't be part of the public API.
1 parent 578dc51 commit 2f855ce

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

rust/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,7 @@ pub use ffi::{IndexOptions, MetricKind, ScalarKind};
481481
/// ```
482482
///
483483
/// In this example, `dimensions` should be defined and valid for the vectors `a` and `b`.
484+
#[doc(hidden)]
484485
pub enum MetricFunctionPtr {
485486
B1X8Metric(*mut std::boxed::Box<dyn Fn(*const b1x8, *const b1x8) -> Distance + Send + Sync>),
486487
I8Metric(*mut std::boxed::Box<dyn Fn(*const i8, *const i8) -> Distance + Send + Sync>),

0 commit comments

Comments
 (0)