System.Directory.Contents.Zipper

This module should be imported qualified due to the very short names it exports.

Zipper

data DirZipper a

A zipper for a DirTree. As you navigate the tree, this keeps track of where you are (which node is "focused" under your cursor) and how to reach parent, child, and sibling nodes.

Constructors

DirZipper

Fields

• _dirZipper_cursor :: DirTree a

  Cursor position

• _dirZipper_siblings :: Map FilePath (DirTree a)

  Siblings

• _dirZipper_elders :: [(DirTree a, Map FilePath (DirTree a))]

  Parents and aunts/uncles, in reverse order (i.e., immediate ancestors first)

Instances

Eq a => Eq (DirZipper a)

Defined in System.Directory.Contents.Zipper

Methods

(==) :: DirZipper a -> DirZipper a -> Bool

(/=) :: DirZipper a -> DirZipper a -> Bool

Ord a => Ord (DirZipper a)

Defined in System.Directory.Contents.Zipper

Methods

compare :: DirZipper a -> DirZipper a -> Ordering

(<) :: DirZipper a -> DirZipper a -> Bool

(<=) :: DirZipper a -> DirZipper a -> Bool

(>) :: DirZipper a -> DirZipper a -> Bool

(>=) :: DirZipper a -> DirZipper a -> Bool

max :: DirZipper a -> DirZipper a -> DirZipper a

min :: DirZipper a -> DirZipper a -> DirZipper a

Read a => Read (DirZipper a)

Defined in System.Directory.Contents.Zipper

Methods

readsPrec :: Int -> ReadS (DirZipper a)

readList :: ReadS [DirZipper a]

readPrec :: ReadPrec (DirZipper a)

readListPrec :: ReadPrec [DirZipper a]

Show a => Show (DirZipper a)

Defined in System.Directory.Contents.Zipper

Methods

showsPrec :: Int -> DirZipper a -> ShowS

show :: DirZipper a -> String

showList :: [DirZipper a] -> ShowS

zipped :: DirTree a -> DirZipper a

Construct a zipper out of a DirTree. Use focused or unzipped to get back a DirTree

focused :: DirZipper a -> DirTree a

The currently focused/selected node (and its children). In other words, where you are in the directory hierarchy.

unzipped :: DirZipper a -> DirTree a

Throws away your current cursor information and returns the entire DirTree contained by the DirZipper.

unzipped . zipped == id

down :: DirZipper a -> Maybe (DirZipper a)

Move down a level in the directory hierarchy. To move down to a specific child, use downTo.

up :: DirZipper a -> Maybe (DirZipper a)

Move up a level in the directory hierarchy, back to the parent that you previously moved down through.

home :: DirZipper a -> DirZipper a

Go to the top of the directory hierarchy.

data NavSibling

Navigation directions for sibling nodes

Constructors

NavLeft

NavRight

nextSibling :: NavSibling -> DirZipper a -> Maybe (DirZipper a)

Move to the sibling next to the focused node

left :: DirZipper a -> Maybe (DirZipper a)

Move to the sibling to the left of the focused node

right :: DirZipper a -> Maybe (DirZipper a)

Move to the sibling to the right of the focused node

toSibling :: FileName -> DirZipper a -> Maybe (DirZipper a)

Go to a particular sibling

downTo :: FileName -> DirZipper a -> Maybe (DirZipper a)

Move down in the directory hierarchy to a particular child

mapCursor :: (DirTree a -> DirTree a) -> DirZipper a -> DirZipper a

Modify the focused node

replaceCursor :: DirTree a -> DirZipper a -> DirZipper a

Replace the focused node

insert :: DirTree a -> DirZipper a -> DirZipper a

Add a new sibling to the focused node's generation and focus on it

remove :: DirZipper a -> Maybe (DirZipper a)

Remove the focused node

followRelative :: FilePath -> DirZipper a -> Maybe (DirZipper a)

Try to navigate the provided (possibly relative) path.

followLink :: DirZipper a -> Maybe (DirZipper a)

If the focused node is an internal symlink (see Symlink), try to get to the target.