Skip to main content

DirectoryTreeEvent

Enum DirectoryTreeEvent 

Source
pub enum DirectoryTreeEvent {
    Toggled(PathBuf),
    Selected(PathBuf, bool, SelectionMode),
    Drag(DragMsg),
    DragCompleted {
        sources: Vec<PathBuf>,
        destination: PathBuf,
    },
    Loaded(LoadPayload),
}
Expand description

A message emitted by or consumed by the DirectoryTree widget.

§For parent applications

Wrap this in one of your own Message variants:

enum MyMessage {
    Tree(iced_swdir_tree::DirectoryTreeEvent),
    // ...
}

Route every Tree(event) to DirectoryTree::update and map its returned Task back. Pattern-match on Toggled / Selected before forwarding if you want app-level side effects (e.g. previewing the selected file):

fn update(&mut self, msg: MyMessage) -> Task<MyMessage> {
    match msg {
        MyMessage::Tree(event) => {
            if let DirectoryTreeEvent::Selected(path, _, _) = &event {
                self.preview(path);
            }
            self.tree.update(event).map(MyMessage::Tree)
        }
    }
}

Variants§

§

Toggled(PathBuf)

A folder was toggled open/closed by the user.

On first expansion the widget issues an async scan whose result arrives later as DirectoryTreeEvent::Loaded. Subsequent toggles of the same folder are instant — children stay in the internal cache.

§

Selected(PathBuf, bool, SelectionMode)

A row was selected.

The bool indicates whether the path is a directory (true) or a file (false). The SelectionMode controls how the click composes with any existing selection — see its docs for the full matrix.

The built-in view always emits this with SelectionMode::Replace because iced 0.14’s button callbacks cannot observe modifier keys at press time. Applications that want multi-select track modifier state themselves (see examples/multi_select.rs) and rewrite the mode before forwarding the event — SelectionMode::from_modifiers makes that a one-liner.

§

Drag(DragMsg)

Internal drag-machinery event.

Emitted by the widget’s built-in view as the user presses a row, moves across others, and releases. Applications should treat these as opaque and always route them back to DirectoryTree::update — just like Loaded.

The widget’s internal state machine may produce a Selected or a DragCompleted as the downstream effect of a Drag message. Apps observe those downstream events via the usual .map(MyMessage::Tree) routing — no extra plumbing needed.

§

DragCompleted

The user completed a drag gesture with intent to move (or otherwise transplant) sources into destination.

The widget performs no filesystem operation on its own. Applications observe this event, perform whatever action they wish (move, copy, symlink, upload, ignore), and re-scan affected folders by emitting Toggled events (collapse then re-expand) to refresh the tree view.

destination is guaranteed to be a directory that is not itself in sources nor a descendant of any source — see DragMsg for the validity rules. sources is non-empty.

Fields

§sources: Vec<PathBuf>

One or more paths the user started dragging. This is the selected set at drag start if the pressed row was in the selection, otherwise just the pressed row.

§destination: PathBuf

The folder over which the user released the mouse.

§

Loaded(LoadPayload)

Internal: an asynchronous scan completed.

Parent applications should not construct this variant themselves; it is produced by iced::Tasks that DirectoryTree::update returns and is routed back to update through the app’s message plumbing. Treat it as opaque.

Trait Implementations§

Source§

impl Clone for DirectoryTreeEvent

Source§

fn clone(&self) -> DirectoryTreeEvent

Returns a duplicate 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 DirectoryTreeEvent

Source§

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

Formats the value using the given formatter. Read more

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,