You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/index.rs
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -80,11 +80,19 @@ pub struct Indexer<'object> {
80
80
marker:PhantomData<&'object()>,
81
81
}
82
82
83
-
// Trait that indicates that object can be used for indexing
84
-
//
85
-
// Any object to be able to be passed on to [./struct.Indexer.html#method.set_index] method
86
-
// should implement this trait with appropriate implementation
83
+
/// Trait bound indicating indexability
84
+
///
85
+
/// Any object to be able to be passed on to [Indexer::set_index()](./struct.Indexer.html#method.set_index) method should implement this trait with appropriate implementation of `set` method.
87
86
pubtraitIndexable{
87
+
/// Set indexing object for a given dimension
88
+
///
89
+
/// # Parameters
90
+
///
91
+
/// - `idxr` is mutable reference to [Indexer](./struct.Indexer.html) object which will
92
+
/// be modified to set `self` indexable along `dim` dimension.
93
+
/// - `dim` is the dimension along which `self` indexable will be used for indexing.
94
+
/// - `is_batch` is only used if `self` is [Seq](./struct.Seq.html) to indicate if indexing
0 commit comments