FILE::DIR 1g 2024-09-12 laplante@plcb.ca GOWEB/FILE

title: “FILE::DIR” date: 2024-09-12 author: “laplante@plcb.ca” version: “1.0.0”

category: “GOWEB/FILE”

Name

FILE::DIR — Returns an array containing the list of entries in a directory.

Synopsis

file::dir or dir(directory [error: variable, sort: func, keys: array, filter: func])

Description

This function returns an array containing the list of entries in a directory.
Each entry is represented as a map with the following keys (unless the keys parameter is specified):

{
    "Atime": "2024-08-16 12:17:33.911805761 -0400 EDT",
    "Ctime": "2024-08-16 12:17:15.214152534 -0400 EDT",
    "IsCharDevice": false,
    "IsDevice": false,
    "IsDir": false,
    "IsIrregular": false,
    "IsNamedPipe": true,
    "IsRegular": false,
    "IsSetgid": false,
    "IsSetuid": false,
    "IsSocket": false,
    "IsSticky": false,
    "IsSymlink": false,
    "Mtime": "2024-08-16 12:17:15.214152534 -0400 EDT",
    "Name": "06A12886-C4A4-4C57-92BD-126EC11F2CA5_IN",
    "Perm": 438,
    "Size": 0
}

Sort function: takes two parameters and returns a boolean for comparison.

func s(a, b) {
    return a.Name < b.Name;
}

Filter function: takes one parameter and returns a boolean to decide if the entry should be kept.

func f(arg) {
    return ! arg.IsDir;
}

Parameters

error : captures an error if the directory does not exist.
sort : specifies a custom sort function.
filter : specifies a filter function.
keys : specifies an array with the list of keys to keep.

Examples

func f(arg) {
    return ! arg.IsDir;
}

func s(a, b) {
    return a.Name < b.Name;
}

x := dir(filter: f, sort: s, keys: ["Name","Atime"]);

Author

laplante@plcb.ca

Version

1.0.0 2024-09-12 laplante@plcb.ca initial version