fltk::tree

Struct TreeItem

Source 
pub struct TreeItem { /* private fields */ }
Expand description

Defines a tree item

Implementations§

Source§

impl TreeItem

Source

pub unsafe fn from_raw(ptr: *mut Fl_Tree_Item) -> Option<TreeItem>

Create a TreeItem from a raw pointer

§Safety

The pointer must be valid

Source

pub fn new(tree: &Tree, label: &str) -> Self

Creates a new TreeItem

Source

pub fn draw_item_content<F: FnMut(&mut Self, bool) -> i32>(&mut self, cb: F)

Overrides the draw_item_content method Example usage:

use fltk::{draw, enums::*, tree};
let mut tree = tree::Tree::default();
let mut item = tree::TreeItem::new(&tree, "Hello");
item.draw_item_content(|item, render| {
    // Our item's dimensions + text content
    let x = item.label_x();
    let y = item.label_y();
    let w = item.label_w();
    let h = item.label_h();
    let txt = if let Some(txt) = item.label() {
        txt
    } else {
        String::new()
    };
    if render {
        // Draw bg -- a filled rectangle
        draw::draw_rect_fill(x, y, w, h, item.label_bgcolor());
        // Draw label
        draw::set_font(Font::Helvetica, 14);
        draw::set_draw_color(Color::Foreground); // use recommended fg color
        draw::draw_text_boxed(&txt, x, y, w, h, Align::Left); // draw the item's label
    }
    // Rendered or not, we must calculate content's max X position
    let (lw, _) = draw::measure(&txt, true); // get width of label text
    return x + lw; // return X + label width
});
// Add our custom item to a path
let _third = tree.add_item("first/second/thrid", &item).unwrap();
Source

pub fn set_user_data<T: Clone + 'static>(&mut self, data: T)

Set the internal data of the tree item

§Warning

This method doesn’t store the type information of the passed data

Source

pub unsafe fn user_data<T: Clone + 'static>(&self) -> Option<T>

Get the stored data in the tree item

§Safety

Setting the user data doesn’t store type information, as such it’s on the developer to maintain the correct type

Source

pub fn x(&self) -> i32

Gets the x position

Source

pub fn y(&self) -> i32

Gets the y position

Examples found in repository?
examples/tree.rs (line 59)
45    fn new(x: i32, y: i32, width: i32, height: i32, title: &'static str) -> Self {
46        let mut t_widget = Tree::new(x, y, width, height, title);
47        let previous_focus = Rc::new(RefCell::new(None::<TreeItem>));
48        let pfr = Rc::clone(&previous_focus);
49        t_widget.set_callback_reason(TreeReason::Selected);
50        t_widget.set_callback(|_t| println!("clicked an item"));
51        t_widget.handle(move |t, e| match e {
52            Event::Move => {
53                let (_, mouse_y) = app::event_coords();
54                let mut state = State::Undefined;
55                let mut pf = pfr.borrow_mut();
56                loop {
57                    match &*pf {
58                        Some(item) => {
59                            let item_y = item.y();
60                            match state {
61                                State::MovingUp => {
62                                    if verify_open_till_root(&pf) {
63                                        if mouse_y < item_y {
64                                            *pf = pf.as_ref().unwrap().prev();
65                                            continue;
66                                        };
67                                        break;
68                                    } else {
69                                        *pf = pf.as_ref().unwrap().prev();
70                                        continue;
71                                    }
72                                }
73                                State::MovingDown => {
74                                    if verify_open_till_root(&pf) {
75                                        if mouse_y > item_y + item.h() {
76                                            *pf = pf.as_ref().unwrap().next();
77                                            continue;
78                                        };
79                                        break;
80                                    } else {
81                                        *pf = pf.as_ref().unwrap().next();
82                                        continue;
83                                    }
84                                }
85                                State::Undefined => {
86                                    if mouse_y < item_y {
87                                        *pf = pf.as_ref().unwrap().prev();
88                                        state = State::MovingUp;
89                                        continue;
90                                    };
91                                    if mouse_y > item_y + item.h() {
92                                        *pf = pf.as_ref().unwrap().next();
93                                        state = State::MovingDown;
94                                        continue;
95                                    };
96                                    return true; // If in same range, don't update 'previous_focus'
97                                }
98                            }
99                        }
100                        // End up here if y is outside tree boundaries, or no tree item is present
101                        None => match &state {
102                            State::MovingUp | State::MovingDown => return true,
103                            State::Undefined => {
104                                *pf = t.first();
105                                state = State::MovingDown;
106                                if pf.is_none() {
107                                    return true;
108                                }
109                                continue;
110                            }
111                        },
112                    };
113                }
114                if verify_open_till_root(&pf) {
115                    t.take_focus().ok();
116                    t.set_item_focus(pf.as_ref().unwrap());
117                    println!("Set focus to item: {:?}", pf.as_ref().unwrap().label());
118                }
119                true
120            }
121            _ => false,
122        });
123        Self {
124            t_widget,
125            previous_focus,
126        }
127    }
Source

pub fn w(&self) -> i32

Gets the width

Source

pub fn h(&self) -> i32

Gets the height

Examples found in repository?
examples/tree.rs (line 75)
45    fn new(x: i32, y: i32, width: i32, height: i32, title: &'static str) -> Self {
46        let mut t_widget = Tree::new(x, y, width, height, title);
47        let previous_focus = Rc::new(RefCell::new(None::<TreeItem>));
48        let pfr = Rc::clone(&previous_focus);
49        t_widget.set_callback_reason(TreeReason::Selected);
50        t_widget.set_callback(|_t| println!("clicked an item"));
51        t_widget.handle(move |t, e| match e {
52            Event::Move => {
53                let (_, mouse_y) = app::event_coords();
54                let mut state = State::Undefined;
55                let mut pf = pfr.borrow_mut();
56                loop {
57                    match &*pf {
58                        Some(item) => {
59                            let item_y = item.y();
60                            match state {
61                                State::MovingUp => {
62                                    if verify_open_till_root(&pf) {
63                                        if mouse_y < item_y {
64                                            *pf = pf.as_ref().unwrap().prev();
65                                            continue;
66                                        };
67                                        break;
68                                    } else {
69                                        *pf = pf.as_ref().unwrap().prev();
70                                        continue;
71                                    }
72                                }
73                                State::MovingDown => {
74                                    if verify_open_till_root(&pf) {
75                                        if mouse_y > item_y + item.h() {
76                                            *pf = pf.as_ref().unwrap().next();
77                                            continue;
78                                        };
79                                        break;
80                                    } else {
81                                        *pf = pf.as_ref().unwrap().next();
82                                        continue;
83                                    }
84                                }
85                                State::Undefined => {
86                                    if mouse_y < item_y {
87                                        *pf = pf.as_ref().unwrap().prev();
88                                        state = State::MovingUp;
89                                        continue;
90                                    };
91                                    if mouse_y > item_y + item.h() {
92                                        *pf = pf.as_ref().unwrap().next();
93                                        state = State::MovingDown;
94                                        continue;
95                                    };
96                                    return true; // If in same range, don't update 'previous_focus'
97                                }
98                            }
99                        }
100                        // End up here if y is outside tree boundaries, or no tree item is present
101                        None => match &state {
102                            State::MovingUp | State::MovingDown => return true,
103                            State::Undefined => {
104                                *pf = t.first();
105                                state = State::MovingDown;
106                                if pf.is_none() {
107                                    return true;
108                                }
109                                continue;
110                            }
111                        },
112                    };
113                }
114                if verify_open_till_root(&pf) {
115                    t.take_focus().ok();
116                    t.set_item_focus(pf.as_ref().unwrap());
117                    println!("Set focus to item: {:?}", pf.as_ref().unwrap().label());
118                }
119                true
120            }
121            _ => false,
122        });
123        Self {
124            t_widget,
125            previous_focus,
126        }
127    }
Source

pub fn label_x(&self) -> i32

Gets the label’s x position

Source

pub fn label_y(&self) -> i32

Gets the label’s y position

Source

pub fn label_w(&self) -> i32

Gets the label’s width

Source

pub fn label_h(&self) -> i32

Gets the label’s height

Source

pub fn show_self(&self, indent: &str)

Shows the tree item

Source

pub fn set_label(&mut self, val: &str)

Sets the label of the tree item

Examples found in repository?
examples/tree.rs (line 166)
146fn main() {
147    let path = env::current_dir().unwrap();
148    let path: String = path
149        .to_str()
150        .unwrap()
151        .chars()
152        .map(|c| match c {
153            '\\' => '/', // change window paths to posix paths
154            _ => c,
155        })
156        .collect();
157
158    let app = app::App::default().with_scheme(app::Scheme::Gtk);
159    let mut wind = Window::default().with_size(400, 300);
160    let mut but = Button::new(260, 255, 80, 40, "Get Items");
161    let _frame = Frame::new(20, 255, 160, 40, "Focus follow mouse");
162    let mut tree = TreeMouseFocus::new(5, 10, 190, 240, "");
163    tree.add(&path);
164
165    let mut items = tree.get_items().unwrap();
166    items.as_mut_slice()[0].set_label("/");
167
168    let mut tree2 = Tree::new(205, 10, 190, 240, "");
169    tree2.set_select_mode(TreeSelect::Multi);
170    tree2.add("First");
171    tree2.add("First/1st");
172    tree2.add("First/2nd/3rd");
173    tree2.add("Second");
174    tree2.add("Third");
175
176    tree2.set_when(fltk::enums::When::ReleaseAlways);
177
178    wind.make_resizable(true);
179    wind.show();
180
181    but.set_callback({
182        let tree2 = tree2.clone();
183        move |_| match tree2.get_selected_items() {
184            None => println!("No items selected"),
185            Some(vals) => print!(
186                "In total {} items selected:\n{}",
187                vals.len(),
188                vals.iter()
189                    .map(|i| tree2.item_pathname(i).unwrap() + "\n")
190                    .collect::<String>()
191            ),
192        }
193    });
194
195    app.run().unwrap();
196}
Source

pub fn label(&self) -> Option<String>

Gets the label of the tree item

Examples found in repository?
examples/tree.rs (line 117)
45    fn new(x: i32, y: i32, width: i32, height: i32, title: &'static str) -> Self {
46        let mut t_widget = Tree::new(x, y, width, height, title);
47        let previous_focus = Rc::new(RefCell::new(None::<TreeItem>));
48        let pfr = Rc::clone(&previous_focus);
49        t_widget.set_callback_reason(TreeReason::Selected);
50        t_widget.set_callback(|_t| println!("clicked an item"));
51        t_widget.handle(move |t, e| match e {
52            Event::Move => {
53                let (_, mouse_y) = app::event_coords();
54                let mut state = State::Undefined;
55                let mut pf = pfr.borrow_mut();
56                loop {
57                    match &*pf {
58                        Some(item) => {
59                            let item_y = item.y();
60                            match state {
61                                State::MovingUp => {
62                                    if verify_open_till_root(&pf) {
63                                        if mouse_y < item_y {
64                                            *pf = pf.as_ref().unwrap().prev();
65                                            continue;
66                                        };
67                                        break;
68                                    } else {
69                                        *pf = pf.as_ref().unwrap().prev();
70                                        continue;
71                                    }
72                                }
73                                State::MovingDown => {
74                                    if verify_open_till_root(&pf) {
75                                        if mouse_y > item_y + item.h() {
76                                            *pf = pf.as_ref().unwrap().next();
77                                            continue;
78                                        };
79                                        break;
80                                    } else {
81                                        *pf = pf.as_ref().unwrap().next();
82                                        continue;
83                                    }
84                                }
85                                State::Undefined => {
86                                    if mouse_y < item_y {
87                                        *pf = pf.as_ref().unwrap().prev();
88                                        state = State::MovingUp;
89                                        continue;
90                                    };
91                                    if mouse_y > item_y + item.h() {
92                                        *pf = pf.as_ref().unwrap().next();
93                                        state = State::MovingDown;
94                                        continue;
95                                    };
96                                    return true; // If in same range, don't update 'previous_focus'
97                                }
98                            }
99                        }
100                        // End up here if y is outside tree boundaries, or no tree item is present
101                        None => match &state {
102                            State::MovingUp | State::MovingDown => return true,
103                            State::Undefined => {
104                                *pf = t.first();
105                                state = State::MovingDown;
106                                if pf.is_none() {
107                                    return true;
108                                }
109                                continue;
110                            }
111                        },
112                    };
113                }
114                if verify_open_till_root(&pf) {
115                    t.take_focus().ok();
116                    t.set_item_focus(pf.as_ref().unwrap());
117                    println!("Set focus to item: {:?}", pf.as_ref().unwrap().label());
118                }
119                true
120            }
121            _ => false,
122        });
123        Self {
124            t_widget,
125            previous_focus,
126        }
127    }
Source

pub fn set_label_font(&mut self, val: Font)

Sets the label’s font

Source

pub fn label_font(&self) -> Font

Gets the label’s font

Source

pub fn set_label_size(&mut self, sz: i32)

Sets the label’s size

Source

pub fn label_size(&self) -> i32

Gets the label’s size

Source

pub fn set_label_fgcolor(&mut self, val: Color)

Sets the label’s foreground color

Source

pub fn label_fgcolor(&self) -> Color

Gets the label’s foreground color

Source

pub fn set_label_color(&mut self, val: Color)

Sets the label’s color

Source

pub fn label_color(&self) -> Color

Gets the label’s color

Source

pub fn set_label_bgcolor(&mut self, val: Color)

Sets the label’s background color

Source

pub fn label_bgcolor(&self) -> Color

Gets the label’s foreground color

Source

pub fn set_widget<W: WidgetExt>(&mut self, val: &W)

Sets the item’s associated widget

Source

pub fn widget(&self) -> Option<impl WidgetExt>

Gets the item’s associated widget

Source

pub fn children(&self) -> i32

Gets the children count

Source

pub fn child(&self, idx: i32) -> Option<TreeItem>

Gets the child item at idx position

Source

pub fn has_children(&self) -> bool

Returns whether the item has children

Source

pub fn find_child(&mut self, name: &str) -> Result<i32, FltkError>

Find a child using its name, returns index result

§Errors

Errors on failure to find child

Source

pub fn remove_child(&mut self, new_label: &str) -> Result<(), FltkError>

Remove child using its name

§Errors

Errors on failure to remove child

Source

pub fn clear_children(&mut self)

Remove all children

Source

pub fn swap_children( &mut self, a: &TreeItem, b: &TreeItem, ) -> Result<(), FltkError>

Swap children a and b

§Errors

Errors on failure to swap children

Source

pub fn find_child_item(&self, name: &str) -> Option<TreeItem>

Find child by name, returns option of the item

Source

pub fn replace(&mut self, new_item: &TreeItem) -> Option<TreeItem>

Replace a tree item

Source

pub fn replace_child( &mut self, old_item: &TreeItem, new_item: &TreeItem, ) -> Option<TreeItem>

Replace a child

Source

pub fn deparent(&mut self, index: i32) -> Option<TreeItem>

Deparent a child by index

Source

pub fn reparent( &mut self, new_child: &TreeItem, index: i32, ) -> Result<(), FltkError>

Reparent a child by index

§Errors

Errors on failure to move item

Source

pub fn move_item(&mut self, to: i32, from: i32) -> Result<(), FltkError>

Move the item ‘from’ to sibling position of ‘to’.

§Errors

Errors on failure to move item

Source

pub fn move_above(&mut self, item: &TreeItem) -> Result<(), FltkError>

Move the current item above the specified item

§Errors

Errors on failure to move item

Source

pub fn move_below(&mut self, item: &TreeItem) -> Result<(), FltkError>

Move the current item below the specified item

§Errors

Errors on failure to move item

Source

pub fn move_into(&mut self, item: &TreeItem, pos: i32) -> Result<(), FltkError>

Parent the current item as a child of the specified item.

§Errors

Errors on failure to move item

Source

pub fn depth(&self) -> i32

Gets the depth of the item

Source

pub fn prev(&self) -> Option<TreeItem>

Gets the previous item

Examples found in repository?
examples/tree.rs (line 64)
45    fn new(x: i32, y: i32, width: i32, height: i32, title: &'static str) -> Self {
46        let mut t_widget = Tree::new(x, y, width, height, title);
47        let previous_focus = Rc::new(RefCell::new(None::<TreeItem>));
48        let pfr = Rc::clone(&previous_focus);
49        t_widget.set_callback_reason(TreeReason::Selected);
50        t_widget.set_callback(|_t| println!("clicked an item"));
51        t_widget.handle(move |t, e| match e {
52            Event::Move => {
53                let (_, mouse_y) = app::event_coords();
54                let mut state = State::Undefined;
55                let mut pf = pfr.borrow_mut();
56                loop {
57                    match &*pf {
58                        Some(item) => {
59                            let item_y = item.y();
60                            match state {
61                                State::MovingUp => {
62                                    if verify_open_till_root(&pf) {
63                                        if mouse_y < item_y {
64                                            *pf = pf.as_ref().unwrap().prev();
65                                            continue;
66                                        };
67                                        break;
68                                    } else {
69                                        *pf = pf.as_ref().unwrap().prev();
70                                        continue;
71                                    }
72                                }
73                                State::MovingDown => {
74                                    if verify_open_till_root(&pf) {
75                                        if mouse_y > item_y + item.h() {
76                                            *pf = pf.as_ref().unwrap().next();
77                                            continue;
78                                        };
79                                        break;
80                                    } else {
81                                        *pf = pf.as_ref().unwrap().next();
82                                        continue;
83                                    }
84                                }
85                                State::Undefined => {
86                                    if mouse_y < item_y {
87                                        *pf = pf.as_ref().unwrap().prev();
88                                        state = State::MovingUp;
89                                        continue;
90                                    };
91                                    if mouse_y > item_y + item.h() {
92                                        *pf = pf.as_ref().unwrap().next();
93                                        state = State::MovingDown;
94                                        continue;
95                                    };
96                                    return true; // If in same range, don't update 'previous_focus'
97                                }
98                            }
99                        }
100                        // End up here if y is outside tree boundaries, or no tree item is present
101                        None => match &state {
102                            State::MovingUp | State::MovingDown => return true,
103                            State::Undefined => {
104                                *pf = t.first();
105                                state = State::MovingDown;
106                                if pf.is_none() {
107                                    return true;
108                                }
109                                continue;
110                            }
111                        },
112                    };
113                }
114                if verify_open_till_root(&pf) {
115                    t.take_focus().ok();
116                    t.set_item_focus(pf.as_ref().unwrap());
117                    println!("Set focus to item: {:?}", pf.as_ref().unwrap().label());
118                }
119                true
120            }
121            _ => false,
122        });
123        Self {
124            t_widget,
125            previous_focus,
126        }
127    }
Source

pub fn next(&self) -> Option<TreeItem>

Gets the next item

Examples found in repository?
examples/tree.rs (line 76)
45    fn new(x: i32, y: i32, width: i32, height: i32, title: &'static str) -> Self {
46        let mut t_widget = Tree::new(x, y, width, height, title);
47        let previous_focus = Rc::new(RefCell::new(None::<TreeItem>));
48        let pfr = Rc::clone(&previous_focus);
49        t_widget.set_callback_reason(TreeReason::Selected);
50        t_widget.set_callback(|_t| println!("clicked an item"));
51        t_widget.handle(move |t, e| match e {
52            Event::Move => {
53                let (_, mouse_y) = app::event_coords();
54                let mut state = State::Undefined;
55                let mut pf = pfr.borrow_mut();
56                loop {
57                    match &*pf {
58                        Some(item) => {
59                            let item_y = item.y();
60                            match state {
61                                State::MovingUp => {
62                                    if verify_open_till_root(&pf) {
63                                        if mouse_y < item_y {
64                                            *pf = pf.as_ref().unwrap().prev();
65                                            continue;
66                                        };
67                                        break;
68                                    } else {
69                                        *pf = pf.as_ref().unwrap().prev();
70                                        continue;
71                                    }
72                                }
73                                State::MovingDown => {
74                                    if verify_open_till_root(&pf) {
75                                        if mouse_y > item_y + item.h() {
76                                            *pf = pf.as_ref().unwrap().next();
77                                            continue;
78                                        };
79                                        break;
80                                    } else {
81                                        *pf = pf.as_ref().unwrap().next();
82                                        continue;
83                                    }
84                                }
85                                State::Undefined => {
86                                    if mouse_y < item_y {
87                                        *pf = pf.as_ref().unwrap().prev();
88                                        state = State::MovingUp;
89                                        continue;
90                                    };
91                                    if mouse_y > item_y + item.h() {
92                                        *pf = pf.as_ref().unwrap().next();
93                                        state = State::MovingDown;
94                                        continue;
95                                    };
96                                    return true; // If in same range, don't update 'previous_focus'
97                                }
98                            }
99                        }
100                        // End up here if y is outside tree boundaries, or no tree item is present
101                        None => match &state {
102                            State::MovingUp | State::MovingDown => return true,
103                            State::Undefined => {
104                                *pf = t.first();
105                                state = State::MovingDown;
106                                if pf.is_none() {
107                                    return true;
108                                }
109                                continue;
110                            }
111                        },
112                    };
113                }
114                if verify_open_till_root(&pf) {
115                    t.take_focus().ok();
116                    t.set_item_focus(pf.as_ref().unwrap());
117                    println!("Set focus to item: {:?}", pf.as_ref().unwrap().label());
118                }
119                true
120            }
121            _ => false,
122        });
123        Self {
124            t_widget,
125            previous_focus,
126        }
127    }
Source

pub fn next_sibling(&self) -> Option<TreeItem>

Gets the next sibling

Source

pub fn prev_sibling(&self) -> Option<TreeItem>

Gets the previous sibling

Source

pub fn update_prev_next(&mut self, index: i32)

Update surrounding siblings

Source

pub fn parent(&self) -> Option<TreeItem>

Return the parent of the item

Examples found in repository?
examples/tree.rs (line 26)
23fn verify_open_till_root(opt: &Option<fltk::tree::TreeItem>) -> bool {
24    let mut par = opt.clone();
25    loop {
26        match par.as_ref().unwrap().parent() {
27            Some(p) => {
28                if p.is_close() {
29                    return false;
30                } else {
31                    par = Some(p.clone());
32                }
33            }
34            None => return true,
35        }
36    }
37}
Source

pub fn set_parent(&mut self, val: &TreeItem)

Set the parent of the item

Source

pub fn tree(&self) -> Option<Tree>

Return the tree of the item

Source

pub fn open(&mut self)

Open the item exposing all children

Source

pub fn close(&mut self)

Close the item hiding all children

Source

pub fn is_open(&self) -> bool

Returns whether an item is open

Source

pub fn is_close(&self) -> bool

Returns whether an item is closed

Examples found in repository?
examples/tree.rs (line 28)
23fn verify_open_till_root(opt: &Option<fltk::tree::TreeItem>) -> bool {
24    let mut par = opt.clone();
25    loop {
26        match par.as_ref().unwrap().parent() {
27            Some(p) => {
28                if p.is_close() {
29                    return false;
30                } else {
31                    par = Some(p.clone());
32                }
33            }
34            None => return true,
35        }
36    }
37}
Source

pub fn open_toggle(&mut self)

Toggle the open state of the item

Source

pub fn select(&mut self, index: i32)

Select an item at index

Source

pub fn select_toggle(&mut self)

Toggle the select state of an item

Source

pub fn select_all(&mut self) -> i32

Select all subitems, returns number of selected items

Source

pub fn deselect(&mut self)

Deselect an item

Source

pub fn deselect_all(&mut self) -> i32

Deselect all subitems

Source

pub fn is_root(&self) -> bool

Returns whether an item is root

Source

pub fn is_visible(&self) -> bool

Returns whether an item is visible

Source

pub fn is_active(&self) -> bool

Returns whether an item is active

Source

pub fn is_activated(&self) -> bool

Returns whether an item is activated

Source

pub fn deactivate(&mut self)

Deactivate an item

Source

pub fn activate(&mut self, val: bool)

Activate an item

Source

pub fn is_selected(&self) -> bool

Returns whether an item is selected

Source

pub fn was_deleted(&self) -> bool

Check if the tree item was deleted

Source

pub fn user_icon(&self) -> Option<Box<dyn ImageExt>>

Gets the user icon

Source

pub fn set_user_icon<Img: ImageExt>(&mut self, image: Option<Img>)

Sets the user icon

Source

pub fn as_ptr(&self) -> *mut Fl_Tree_Item

Return the internal pointer of the tree item

Trait Implementations§

Source§

impl Clone for TreeItem

Source§

fn clone(&self) -> TreeItem ⓘ

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TreeItem

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Iterator for TreeItem

Source§

fn next(&mut self) -> Option<Self::Item>

Gets the next item

Source§

type Item = TreeItem

The type of the elements being iterated over.
Source§

fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>
where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)
Advances the iterator and returns an array containing the next N values. Read more
1.0.0 · Source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more
1.0.0 · Source§

fn count(self) -> usize
where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it. Read more
1.0.0 · Source§

fn last(self) -> Option<Self::Item>
where Self: Sized,

Consumes the iterator, returning the last element. Read more
Source§

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator by n elements. Read more
1.0.0 · Source§

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator. Read more
1.28.0 · Source§

fn step_by(self, step: usize) -> StepBy<Self>
where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
1.0.0 · Source§

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence. Read more
1.0.0 · Source§

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>
where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs. Read more
Source§

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places a copy of separator between adjacent items of the original iterator. Read more
Source§

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places an item generated by separator between adjacent items of the original iterator. Read more
1.0.0 · Source§

fn map<B, F>(self, f: F) -> Map<Self, F>
where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element. Read more
1.21.0 · Source§

fn for_each<F>(self, f: F)
where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator. Read more
1.0.0 · Source§

fn filter<P>(self, predicate: P) -> Filter<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded. Read more
1.0.0 · Source§

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps. Read more
1.0.0 · Source§

fn enumerate(self) -> Enumerate<Self>
where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value. Read more
1.0.0 · Source§

fn peekable(self) -> Peekable<Self>
where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more
1.0.0 · Source§

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate. Read more
1.0.0 · Source§

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate. Read more
1.57.0 · Source§

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps. Read more
1.0.0 · Source§

fn skip(self, n: usize) -> Skip<Self>
where Self: Sized,

Creates an iterator that skips the first n elements. Read more
1.0.0 · Source§

fn take(self, n: usize) -> Take<Self>
where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more
1.0.0 · Source§

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator. Read more
1.0.0 · Source§

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure. Read more
1.29.0 · Source§

fn flatten(self) -> Flatten<Self>
where Self: Sized, Self::Item: IntoIterator,

Creates an iterator that flattens nested structure. Read more
Source§

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)
Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well. Read more
1.0.0 · Source§

fn fuse(self) -> Fuse<Self>
where Self: Sized,

Creates an iterator which ends after the first None. Read more
1.0.0 · Source§

fn inspect<F>(self, f: F) -> Inspect<Self, F>
where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Iterator. Read more
1.0.0 · Source§

fn collect<B>(self) -> B
where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection. Read more
Source§

fn collect_into<E>(self, collection: &mut E) -> &mut E
where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)
Collects all the items from an iterator into a collection. Read more
1.0.0 · Source§

fn partition<B, F>(self, f: F) -> (B, B)
where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it. Read more
Source§

fn is_partitioned<P>(self, predicate: P) -> bool
where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)
Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false. Read more
1.27.0 · Source§

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
1.27.0 · Source§

fn try_for_each<F, R>(&mut self, f: F) -> R
where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
1.0.0 · Source§

fn fold<B, F>(self, init: B, f: F) -> B
where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result. Read more
1.51.0 · Source§

fn reduce<F>(self, f: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
Source§

fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
where Self: Sized, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)
Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
1.0.0 · Source§

fn all<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate. Read more
1.0.0 · Source§

fn any<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate. Read more
1.0.0 · Source§

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate. Read more
1.30.0 · Source§

fn find_map<B, F>(&mut self, f: F) -> Option<B>
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result. Read more
Source§

fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
where Self: Sized, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)
Applies function to the elements of iterator and returns the first true result or the first error. Read more
1.0.0 · Source§

fn position<P>(&mut self, predicate: P) -> Option<usize>
where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index. Read more
1.6.0 · Source§

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function. Read more
1.15.0 · Source§

fn max_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function. Read more
1.6.0 · Source§

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function. Read more
1.15.0 · Source§

fn min_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function. Read more
1.0.0 · Source§

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers. Read more
1.36.0 · Source§

fn copied<'a, T>(self) -> Copied<Self>
where T: 'a + Copy, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements. Read more
1.0.0 · Source§

fn cloned<'a, T>(self) -> Cloned<Self>
where T: 'a + Clone, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements. Read more
1.0.0 · Source§

fn cycle(self) -> Cycle<Self>
where Self: Sized + Clone,

Repeats an iterator endlessly. Read more
Source§

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>
where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)
Returns an iterator over N elements of the iterator at a time. Read more
1.11.0 · Source§

fn sum<S>(self) -> S
where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator. Read more
1.11.0 · Source§

fn product<P>(self) -> P
where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements Read more
Source§

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
1.5.0 · Source§

fn partial_cmp<I>(self, other: I) -> Option<Ordering>
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned. Read more
Source§

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
1.5.0 · Source§

fn eq<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another. Read more
Source§

fn eq_by<I, F>(self, other: I, eq: F) -> bool
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)
Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function. Read more
1.5.0 · Source§

fn ne<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another. Read more
1.5.0 · Source§

fn lt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another. Read more
1.5.0 · Source§

fn le<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more
1.5.0 · Source§

fn gt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more
1.5.0 · Source§

fn ge<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more
1.82.0 · Source§

fn is_sorted_by<F>(self, compare: F) -> bool
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

Checks if the elements of this iterator are sorted using the given comparator function. Read more
1.82.0 · Source§

fn is_sorted_by_key<F, K>(self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

Checks if the elements of this iterator are sorted using the given key extraction function. Read more
Source§

impl PartialEq for TreeItem

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for TreeItem

Source§

impl Send for TreeItem

Available on non-crate feature single-threaded only.
Source§

impl Sync for TreeItem

Available on non-crate feature single-threaded only.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<I> IntoIterator for I
where I: Iterator,

Source§

type Item = <I as Iterator>::Item

The type of the elements being iterated over.
Source§

type IntoIter = I

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> I

Creates an iterator from a value. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.