Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Michael X. Grey <[email protected]>
  • Loading branch information
mxgrey committed Nov 26, 2024
1 parent 8d53e85 commit 6690273
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/chain/split.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pub trait Splittable: Sized {

/// Return true if the key is feasible for this type of split, otherwise
/// return false. Returning false will cause the user to receive a
/// [`SplitConnectionError::IndexOutOfBounds`]. This will also cause iterating
/// [`SplitConnectionError::KeyOutOfBounds`]. This will also cause iterating
/// to cease.
fn validate(key: &Self::Key) -> bool;

Expand Down Expand Up @@ -357,11 +357,11 @@ where
Key: 'static + Send + Sync + Eq + Hash + Clone + Debug,
Item: 'static + Send + Sync,
{
/// Send a value for a key. The split operation will make sure that this
/// value will be sent to the target associated with the key.
/// Get the output buffer a certain key. If there are no connections for the
/// given key, then this will return [`None`].
///
/// If there is no connection associated with the specified key, the value
/// will be returned as [`Err`].
/// Push items into the output buffer to send them to the input connected to
/// this key.
pub fn outputs_for<'o>(&'o mut self, key: &Key) -> Option<&'o mut Vec<Item>> {
let index = *self.connections.get(key)?;

Expand Down

0 comments on commit 6690273

Please sign in to comment.