xref: /aosp_15_r20/external/bazel-skylib/docs/directory_providers_doc.md (revision bcb5dc7965af6ee42bf2f21341a2ec00233a8c8a)
1*bcb5dc79SHONG Yifan<!-- Generated with Stardoc: http://skydoc.bazel.build -->
2*bcb5dc79SHONG Yifan
3*bcb5dc79SHONG YifanSkylib module containing providers for directories.
4*bcb5dc79SHONG Yifan
5*bcb5dc79SHONG Yifan<a id="DirectoryInfo"></a>
6*bcb5dc79SHONG Yifan
7*bcb5dc79SHONG Yifan## DirectoryInfo
8*bcb5dc79SHONG Yifan
9*bcb5dc79SHONG Yifan<pre>
10*bcb5dc79SHONG YifanDirectoryInfo(<a href="#DirectoryInfo-entries">entries</a>, <a href="#DirectoryInfo-transitive_files">transitive_files</a>, <a href="#DirectoryInfo-path">path</a>, <a href="#DirectoryInfo-human_readable">human_readable</a>, <a href="#DirectoryInfo-get_path">get_path</a>, <a href="#DirectoryInfo-get_file">get_file</a>, <a href="#DirectoryInfo-get_subdirectory">get_subdirectory</a>,
11*bcb5dc79SHONG Yifan              <a href="#DirectoryInfo-glob">glob</a>)
12*bcb5dc79SHONG Yifan</pre>
13*bcb5dc79SHONG Yifan
14*bcb5dc79SHONG YifanInformation about a directory
15*bcb5dc79SHONG Yifan
16*bcb5dc79SHONG Yifan**FIELDS**
17*bcb5dc79SHONG Yifan
18*bcb5dc79SHONG Yifan
19*bcb5dc79SHONG Yifan| Name  | Description |
20*bcb5dc79SHONG Yifan| :------------- | :------------- |
21*bcb5dc79SHONG Yifan| <a id="DirectoryInfo-entries"></a>entries |  (Dict[str, Either[File, DirectoryInfo]]) The entries contained directly within. Ordered by filename    |
22*bcb5dc79SHONG Yifan| <a id="DirectoryInfo-transitive_files"></a>transitive_files |  (depset[File]) All files transitively contained within this directory.    |
23*bcb5dc79SHONG Yifan| <a id="DirectoryInfo-path"></a>path |  (string) Path to all files contained within this directory.    |
24*bcb5dc79SHONG Yifan| <a id="DirectoryInfo-human_readable"></a>human_readable |  (string) A human readable identifier for a directory. Useful for providing error messages to a user.    |
25*bcb5dc79SHONG Yifan| <a id="DirectoryInfo-get_path"></a>get_path |  (Function(str) -> DirectoryInfo\|File) A function to return the entry corresponding to the joined path.    |
26*bcb5dc79SHONG Yifan| <a id="DirectoryInfo-get_file"></a>get_file |  (Function(str) -> File) A function to return the entry corresponding to the joined path.    |
27*bcb5dc79SHONG Yifan| <a id="DirectoryInfo-get_subdirectory"></a>get_subdirectory |  (Function(str) -> DirectoryInfo) A function to return the entry corresponding to the joined path.    |
28*bcb5dc79SHONG Yifan| <a id="DirectoryInfo-glob"></a>glob |  (Function(include, exclude, allow_empty=False)) A function that works the same as native.glob.    |
29*bcb5dc79SHONG Yifan
30*bcb5dc79SHONG Yifan
31*bcb5dc79SHONG Yifan<a id="create_directory_info"></a>
32*bcb5dc79SHONG Yifan
33*bcb5dc79SHONG Yifan## create_directory_info
34*bcb5dc79SHONG Yifan
35*bcb5dc79SHONG Yifan<pre>
36*bcb5dc79SHONG Yifancreate_directory_info(<a href="#create_directory_info-kwargs">kwargs</a>)
37*bcb5dc79SHONG Yifan</pre>
38*bcb5dc79SHONG Yifan
39*bcb5dc79SHONG Yifan
40*bcb5dc79SHONG Yifan
41*bcb5dc79SHONG Yifan**PARAMETERS**
42*bcb5dc79SHONG Yifan
43*bcb5dc79SHONG Yifan
44*bcb5dc79SHONG Yifan| Name  | Description | Default Value |
45*bcb5dc79SHONG Yifan| :------------- | :------------- | :------------- |
46*bcb5dc79SHONG Yifan| <a id="create_directory_info-kwargs"></a>kwargs |  <p align="center"> - </p>   |  none |
47*bcb5dc79SHONG Yifan
48*bcb5dc79SHONG Yifan
49