Trait TreeBackend 

pub trait TreeBackend: Sized {
    type Context;
    type Error;
    type ID;
    type Data;

    // Provided methods
    fn tree_view(context: Self::Context) -> TreeView<Self> { ... }
    fn tree_model(context: Self::Context) -> TreeModel<Self> { ... }
    fn symbol(node: &Node<Self>, context: Self::Context) -> Symbol<'_> { ... }
    fn roots(context: Self::Context) -> Result<NodeList<Self>, Self::Error> { ... }
    fn populate(
        node: &mut Node<Self>,
        context: Self::Context,
    ) -> Result<(), Self::Error> { ... }
    fn data(
        node: &mut Node<Self>,
        context: Self::Context,
    ) -> Result<Option<(Self::Data, bool)>, Self::Error> { ... }
    fn handle_selection_changed(cursive: &mut Cursive) { ... }
    fn handle_error(cursive: &mut Cursive, error: Self::Error) { ... }
}

Tree view backend.

Also see SimpleTreeBackend.

Required Associated Types

type Context

A context is provided as an argument to some of the trait functions.

It is intended to be used to access node data. For example, it can be a database connection or a work directory.

The context is stored in the context field of the model. A clone of it will be produced for every call, thus cloning should best be cheap. Consider wrapping it in an Arc.

If you don’t need it, it can be set to ().

type Error

Returned as the Err of some of the trait functions.

You can implement handle_error to display an error message to the user, log it, etc.

If you don’t need it, it can be set to ().

type ID

Each node has an id field of this type.

It can be used by the backend to identify the node in order to retrieve its data, e.g. in populate and data.

It is not otherwise used by the model and does not have to be unique.

If you don’t need it, it can be set to ().

type Data

For associating custom data with nodes.

Node’s have a data function that in turn calls our data function.

Depending on your needs, the data can be optionally cached in the node’s data field.

If you don’t need it, it can be set to ().

Provided Methods

fn tree_view(context: Self::Context) -> TreeView<Self>

Create a tree view with this backend.

Examples found in repository

examples/file_browser.rs (line 17)

fn main() {
    let mut cursive = Cursive::default();

    let current_dir = current_dir().unwrap();
    let mut tree = FileBackend::tree_view(current_dir.into());

    // Populate the first level (just the roots)
    tree.model.populate(Some(1)).unwrap();

    let mut browser = LinearLayout::horizontal();
    browser.add_child(Panel::new(tree.with_name("tree").scrollable()));
    browser.add_child(Panel::new(TextView::new("").with_name("details").scrollable()));

    cursive.add_fullscreen_layer(browser);
    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

examples/simple.rs (line 11)

fn main() {
    let mut cursive = Cursive::default();

    let mut tree = SimpleTreeBackend::tree_view(());

    // A few roots

    tree.model.add_root(NodeKind::Leaf, (), "Hello".into());
    tree.model.add_root(NodeKind::Branch, (), "World".into());

    // Add 10 children to "World"

    let world = tree.model.at_path_mut([1].into()).unwrap();
    for i in 0..10 {
        world.add_child(NodeKind::Leaf, (), format!("Child #{}", i + 1).into());
    }

    // Add 10 grandchildren each to "Child #5" -> "Child #10"
    // Note that we change them to branch in order to support having children

    let mut gc = 0;
    for c in 4..10 {
        let child = tree.model.at_path_mut([1, c].into()).unwrap();
        child.kind = NodeKind::Branch;
        for _ in 0..10 {
            child.add_child(NodeKind::Leaf, (), format!("Grandchild #{}", gc + 1).into());
            gc += 1;
        }
    }

    // Expand all nodes

    tree.model.expand(None).unwrap();

    cursive.add_fullscreen_layer(Panel::new(tree.scrollable()));
    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

fn tree_model(context: Self::Context) -> TreeModel<Self>

Create a tree model with this backend.

fn symbol(node: &Node<Self>, context: Self::Context) -> Symbol<'_>

Get a node’s symbol.

Note that its char count must be 1.

The default implementation uses the node kind and branch state.

fn roots(context: Self::Context) -> Result<NodeList<Self>, Self::Error>

Get the root nodes.

The root nodes must be depth 0 but otherwise can be as pre-populated as you wish. For example, you can provide them with children and optional data.

The default implementation returns an empty list.

fn populate( node: &mut Node<Self>, context: Self::Context, ) -> Result<(), Self::Error>

Populate a node’s children.

The children must have a depth of +1 of the node.

This is called when expanding the node only if it’s children field is None. Setting children to Some, even to an empty list, will ensure that this function won’t be called again for the node until it is set to None.

The default implementation does nothing.

fn data( node: &mut Node<Self>, context: Self::Context, ) -> Result<Option<(Self::Data, bool)>, Self::Error>

Get a node’s data.

This is called when data is accessed only if the field is None. Returning (data, true) will store it in the field as Some. Returning (data, false) will cause this function to be called every time data is accessed.

The default implementation returns None.

fn handle_selection_changed(cursive: &mut Cursive)

Called when the selected node changes, including when the selection is set to None.

Accessing the currently selected node must be done via the tree view, e.g. selected_node. Thus, you may want to wrap the tree view in a NamedView. You can then access it here like so:

match cursive.call_on_name("MyTree", |tree: &mut TreeView<MyBackend>| {
    Ok(match tree.selected_node_mut() {
        Some(node) => node.data(context)?.map(|data| data.something.clone()),
        None => None,
    })
}) {
    Some(Ok(Some(something))) => do_something_with(something),
    Some(Err(error)) => BackendT::handle_error(cursive, error),
    _ => {},
}

fn handle_error(cursive: &mut Cursive, error: Self::Error)

Called when other backend functions return Err.

Examples found in repository

examples/file_browser.rs (line 76)

    fn handle_selection_changed(cursive: &mut Cursive) {
        let content = match cursive.call_on_name("tree", |tree: &mut TreeView<Self>| {
            // Although we're not using the context in data() but we still need to provide it
            let base_directory = tree.model.context.clone();
            Ok(match tree.selected_node_mut() {
                Some(node) => match node.data(base_directory)? {
                    Some(metadata) => Some(format_metadata(&metadata)?),
                    None => None,
                },
                None => None,
            })
        }) {
            Some(Ok(Some(text))) => text,
            Some(Err(error)) => return Self::handle_error(cursive, error),
            _ => "".into(),
        };

        cursive.call_on_name("details", |details: &mut TextView| {
            details.set_content(content);
        });
    }

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl TreeBackend for SimpleTreeBackend

type Context = ()

type Error = ()

type ID = ()

type Data = ()