Skip to content

chore: rename visitor functions #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisonkun merged 1 commit into from
Dec 8, 2025
Merged

chore: rename visitor functions #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions traversable/src/combinator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ pub trait VisitorExt: Visitor {
/// use traversable::Traversable;
/// use traversable::Visitor;
/// use traversable::combinator::VisitorExt;
/// use traversable::function::make_visitor_enter;
/// use traversable::function::visitor_enter;
///
/// #[derive(Traversable)]
/// struct Foo(i32);
Expand All @@ -58,12 +58,12 @@ pub trait VisitorExt: Visitor {
/// bar: Bar(2),
/// };
///
/// let v1 = make_visitor_enter(|foo: &Foo| {
/// let v1 = visitor_enter(|foo: &Foo| {
/// println!("Visiting Foo: {}", foo.0);
/// ControlFlow::<()>::Continue(())
/// });
///
/// let v2 = make_visitor_enter(|bar: &Bar| {
/// let v2 = visitor_enter(|bar: &Bar| {
/// println!("Visiting Bar: {}", bar.0);
/// ControlFlow::<()>::Continue(())
/// });
Expand Down Expand Up @@ -107,7 +107,7 @@ pub trait VisitorMutExt: VisitorMut {
/// use traversable::TraversableMut;
/// use traversable::VisitorMut;
/// use traversable::combinator::VisitorMutExt;
/// use traversable::function::make_visitor_enter_mut;
/// use traversable::function::visitor_enter_mut;
///
/// #[derive(TraversableMut)]
/// struct Foo(i32);
Expand All @@ -126,12 +126,12 @@ pub trait VisitorMutExt: VisitorMut {
/// bar: Bar(2),
/// };
///
/// let v1 = make_visitor_enter_mut(|foo: &mut Foo| {
/// let v1 = visitor_enter_mut(|foo: &mut Foo| {
/// foo.0 += 1;
/// ControlFlow::<()>::Continue(())
/// });
///
/// let v2 = make_visitor_enter_mut(|bar: &mut Bar| {
/// let v2 = visitor_enter_mut(|bar: &mut Bar| {
/// bar.0 *= 2;
/// ControlFlow::<()>::Continue(())
/// });
Expand Down
46 changes: 23 additions & 23 deletions traversable/src/function.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ use core::ops::ControlFlow;
use crate::Visitor;
use crate::VisitorMut;

/// Type returned by `make_visitor` factories.
/// Type returned by `visitor` factories.
pub struct FnVisitor<T, B, F1, F2> {
enter: F1,
leave: F2,
Expand Down Expand Up @@ -95,7 +95,7 @@ type DefaultVisitFnMut<T, B> = fn(&mut T) -> ControlFlow<B>;
///
/// use traversable::Traversable;
/// use traversable::Visitor;
/// use traversable::function::make_visitor;
/// use traversable::function::visitor;
///
/// #[derive(Traversable)]
/// struct Item {
Expand All @@ -105,7 +105,7 @@ type DefaultVisitFnMut<T, B> = fn(&mut T) -> ControlFlow<B>;
/// let item = Item { value: 10 };
/// let mut total_value = 0;
///
/// let mut visitor = make_visitor::<Item, (), _, _>(
/// let mut visitor = visitor::<Item, (), _, _>(
/// |node: &Item| {
/// // enter closure
/// total_value += node.value;
Expand All @@ -121,7 +121,7 @@ type DefaultVisitFnMut<T, B> = fn(&mut T) -> ControlFlow<B>;
/// assert_eq!(total_value, 10);
/// # }
/// ```
pub fn make_visitor<T, B, F1, F2>(enter: F1, leave: F2) -> FnVisitor<T, B, F1, F2>
pub fn visitor<T, B, F1, F2>(enter: F1, leave: F2) -> FnVisitor<T, B, F1, F2>
where
T: Any,
F1: FnMut(&T) -> ControlFlow<B>,
Expand All @@ -135,7 +135,7 @@ where
}
}

/// Similar to [`make_visitor`], but the closure will only be called on entering.
/// Similar to [`visitor`], but the closure will only be called on entering.
///
/// # Example
///
Expand All @@ -149,7 +149,7 @@ where
///
/// use traversable::Traversable;
/// use traversable::Visitor;
/// use traversable::function::make_visitor_enter;
/// use traversable::function::visitor_enter;
///
/// #[derive(Traversable)]
/// struct Item {
Expand All @@ -159,7 +159,7 @@ where
/// let item = Item { value: 20 };
/// let mut count = 0;
///
/// let mut visitor = make_visitor_enter::<Item, (), _>(|node: &Item| {
/// let mut visitor = visitor_enter::<Item, (), _>(|node: &Item| {
/// // enter closure
/// count += 1;
/// ControlFlow::Continue(())
Expand All @@ -169,7 +169,7 @@ where
/// assert_eq!(count, 1);
/// # }
/// ```
pub fn make_visitor_enter<T, B, F>(enter: F) -> FnVisitor<T, B, F, DefaultVisitFn<T, B>>
pub fn visitor_enter<T, B, F>(enter: F) -> FnVisitor<T, B, F, DefaultVisitFn<T, B>>
where
T: Any,
F: FnMut(&T) -> ControlFlow<B>,
Expand All @@ -182,7 +182,7 @@ where
}
}

/// Similar to [`make_visitor`], but the closure will only be called on leaving.
/// Similar to [`visitor`], but the closure will only be called on leaving.
///
/// # Example
///
Expand All @@ -196,7 +196,7 @@ where
///
/// use traversable::Traversable;
/// use traversable::Visitor;
/// use traversable::function::make_visitor_leave;
/// use traversable::function::visitor_leave;
///
/// #[derive(Traversable)]
/// struct Item {
Expand All @@ -206,7 +206,7 @@ where
/// let item = Item { value: 30 };
/// let mut visited_leave = false;
///
/// let mut visitor = make_visitor_leave::<Item, (), _>(|node: &Item| {
/// let mut visitor = visitor_leave::<Item, (), _>(|node: &Item| {
/// // leave closure
/// visited_leave = true;
/// ControlFlow::Continue(())
Expand All @@ -216,7 +216,7 @@ where
/// assert!(visited_leave);
/// # }
/// ```
pub fn make_visitor_leave<T, B, F>(leave: F) -> FnVisitor<T, B, DefaultVisitFn<T, B>, F>
pub fn visitor_leave<T, B, F>(leave: F) -> FnVisitor<T, B, DefaultVisitFn<T, B>, F>
where
T: Any,
F: FnMut(&T) -> ControlFlow<B>,
Expand Down Expand Up @@ -247,7 +247,7 @@ where
///
/// use traversable::TraversableMut;
/// use traversable::VisitorMut;
/// use traversable::function::make_visitor_mut;
/// use traversable::function::visitor_mut;
///
/// #[derive(TraversableMut)]
/// struct Item {
Expand All @@ -256,7 +256,7 @@ where
///
/// let mut item = Item { value: 10 };
///
/// let mut visitor = make_visitor_mut::<Item, (), _, _>(
/// let mut visitor = visitor_mut::<Item, (), _, _>(
/// |node: &mut Item| {
/// // enter_mut closure
/// node.value += 1;
Expand All @@ -272,7 +272,7 @@ where
/// assert_eq!(item.value, 11);
/// # }
/// ```
pub fn make_visitor_mut<T, B, F1, F2>(enter: F1, leave: F2) -> FnVisitor<T, B, F1, F2>
pub fn visitor_mut<T, B, F1, F2>(enter: F1, leave: F2) -> FnVisitor<T, B, F1, F2>
where
T: Any,
F1: FnMut(&mut T) -> ControlFlow<B>,
Expand All @@ -286,7 +286,7 @@ where
}
}

/// Similar to [`make_visitor_mut`], but the closure will only be called on entering.
/// Similar to [`visitor_mut`], but the closure will only be called on entering.
///
/// # Example
///
Expand All @@ -300,7 +300,7 @@ where
///
/// use traversable::TraversableMut;
/// use traversable::VisitorMut;
/// use traversable::function::make_visitor_enter_mut;
/// use traversable::function::visitor_enter_mut;
///
/// #[derive(TraversableMut)]
/// struct Item {
Expand All @@ -310,7 +310,7 @@ where
/// let mut item = Item { value: 20 };
/// let mut count = 0;
///
/// let mut visitor = make_visitor_enter_mut::<Item, (), _>(|node: &mut Item| {
/// let mut visitor = visitor_enter_mut::<Item, (), _>(|node: &mut Item| {
/// // enter_mut closure
/// count += 1;
/// ControlFlow::Continue(())
Expand All @@ -320,7 +320,7 @@ where
/// assert_eq!(count, 1);
/// # }
/// ```
pub fn make_visitor_enter_mut<T, B, F>(enter: F) -> FnVisitor<T, B, F, DefaultVisitFnMut<T, B>>
pub fn visitor_enter_mut<T, B, F>(enter: F) -> FnVisitor<T, B, F, DefaultVisitFnMut<T, B>>
where
T: Any,
F: FnMut(&mut T) -> ControlFlow<B>,
Expand All @@ -333,7 +333,7 @@ where
}
}

/// Similar to [`make_visitor_mut`], but the closure will only be called on leaving.
/// Similar to [`visitor_mut`], but the closure will only be called on leaving.
///
/// # Example
///
Expand All @@ -347,7 +347,7 @@ where
///
/// use traversable::TraversableMut;
/// use traversable::VisitorMut;
/// use traversable::function::make_visitor_leave_mut;
/// use traversable::function::visitor_leave_mut;
///
/// #[derive(TraversableMut)]
/// struct Item {
Expand All @@ -357,7 +357,7 @@ where
/// let mut item = Item { value: 30 };
/// let mut visited_leave = false;
///
/// let mut visitor = make_visitor_leave_mut::<Item, (), _>(|node: &mut Item| {
/// let mut visitor = visitor_leave_mut::<Item, (), _>(|node: &mut Item| {
/// // leave_mut closure
/// visited_leave = true;
/// ControlFlow::Continue(())
Expand All @@ -367,7 +367,7 @@ where
/// assert!(visited_leave);
/// # }
/// ```
pub fn make_visitor_leave_mut<T, B, F>(leave: F) -> FnVisitor<T, B, DefaultVisitFnMut<T, B>, F>
pub fn visitor_leave_mut<T, B, F>(leave: F) -> FnVisitor<T, B, DefaultVisitFnMut<T, B>, F>
where
T: Any,
F: FnMut(&mut T) -> ControlFlow<B>,
Expand Down
8 changes: 4 additions & 4 deletions traversable/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,9 @@ mod impls;
/// For an example of implementing `Visitor`, see the `FileCounter` struct
/// in the [crate-level documentation](self).
///
/// You can also use [`make_visitor`] to create a visitor from closures.
/// You can also use [`visitor`] to create a visitor from closures.
///
/// [`make_visitor`]: function::make_visitor
/// [`visitor`]: function::visitor
pub trait Visitor {
/// The type that can be used to break traversal early.
type Break;
Expand Down Expand Up @@ -220,9 +220,9 @@ pub trait Visitor {
/// # }
/// ```
///
/// You can also use [`make_visitor_mut`] to create a mutable visitor from closures.
/// You can also use [`visitor_mut`] to create a mutable visitor from closures.
///
/// [`make_visitor_mut`]: function::make_visitor_mut
/// [`visitor_mut`]: function::visitor_mut
pub trait VisitorMut {
/// The type that can be used to break traversal early.
type Break;
Expand Down
12 changes: 6 additions & 6 deletions traversable/tests/test_make_visitor.rs → traversable/tests/test_visitor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ use core::ops::ControlFlow;

use traversable::Traversable;
use traversable::TraversableMut;
use traversable::function::make_visitor_enter;
use traversable::function::make_visitor_leave_mut;
use traversable::function::visitor_enter;
use traversable::function::visitor_leave_mut;

#[test]
fn test_make_visitor() {
let mut visitor = make_visitor_enter::<i32, (), _>(|item| {
fn test_visitor() {
let mut visitor = visitor_enter::<i32, (), _>(|item| {
assert_eq!(*item, 42);
ControlFlow::Continue(())
});
Expand All @@ -33,8 +33,8 @@ fn test_make_visitor() {
}

#[test]
fn test_make_visitor_mut() {
let mut visitor = make_visitor_leave_mut::<i32, (), _>(|item| {
fn test_visitor_mut() {
let mut visitor = visitor_leave_mut::<i32, (), _>(|item| {
*item += 1;
ControlFlow::Continue(())
});
Expand Down