\hypertarget{classfz_1_1local__filesys}{}\section{local\+\_\+filesys Class Reference}
\label{classfz_1_1local__filesys}\index{local\_filesys@{local\_filesys}}


This class can be used to enumerate the contents of local directories and to query the metadata of files.  




{\ttfamily \#include $<$local\+\_\+filesys.\+hpp$>$}

\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_a7aead736a07eaf25623ad7bfa1f0ee2d}\label{classfz_1_1local__filesys_a7aead736a07eaf25623ad7bfa1f0ee2d}} 
enum \mbox{\hyperlink{classfz_1_1local__filesys_a7aead736a07eaf25623ad7bfa1f0ee2d}{type}} \{ {\bfseries unknown} = -\/1, 
{\bfseries file}, 
{\bfseries dir}, 
{\bfseries link}
 \}
\begin{DoxyCompactList}\small\item\em Types of files. While \textquotesingle{}everything is a file\textquotesingle{}, a filename can refer to a file proper, a directory or a symbolic link. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_af090458bfdcf8012632c34893b82a31c}\label{classfz_1_1local__filesys_af090458bfdcf8012632c34893b82a31c}} 
{\bfseries local\+\_\+filesys} (\mbox{\hyperlink{classfz_1_1local__filesys}{local\+\_\+filesys}} const \&)=delete
\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_aaebc408da0a11826f9e305238bb0894a}\label{classfz_1_1local__filesys_aaebc408da0a11826f9e305238bb0894a}} 
\mbox{\hyperlink{classfz_1_1local__filesys}{local\+\_\+filesys}} \& {\bfseries operator=} (\mbox{\hyperlink{classfz_1_1local__filesys}{local\+\_\+filesys}} const \&)=delete
\item 
\mbox{\hyperlink{classfz_1_1result}{result}} \mbox{\hyperlink{classfz_1_1local__filesys_a261d6909a4e7461d5dfc48477a333e91}{begin\+\_\+find\+\_\+files}} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} path, bool dirs\+\_\+only=false)
\begin{DoxyCompactList}\small\item\em Begins enumerating a directory. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_af7d34fd29213a981fc7ae428b1ae3ede}\label{classfz_1_1local__filesys_af7d34fd29213a981fc7ae428b1ae3ede}} 
bool \mbox{\hyperlink{classfz_1_1local__filesys_af7d34fd29213a981fc7ae428b1ae3ede}{get\+\_\+next\+\_\+file}} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} \&name)
\begin{DoxyCompactList}\small\item\em Gets the next file in the directory. Call until it returns false. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{classfz_1_1local__filesys_a562a4d9c1f276bd203f2acc3793bcebb}{get\+\_\+next\+\_\+file}} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} \&name, bool \&is\+\_\+link, bool \&is\+\_\+dir, int64\+\_\+t $\ast$size, \mbox{\hyperlink{classfz_1_1datetime}{datetime}} $\ast$modification\+\_\+time, int $\ast$mode)
\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_a4bd6fa746dc55103010357b48ca4b42d}\label{classfz_1_1local__filesys_a4bd6fa746dc55103010357b48ca4b42d}} 
void \mbox{\hyperlink{classfz_1_1local__filesys_a4bd6fa746dc55103010357b48ca4b42d}{end\+\_\+find\+\_\+files}} ()
\begin{DoxyCompactList}\small\item\em Ends enumerating files. Automatically called in the destructor. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static bool \mbox{\hyperlink{classfz_1_1local__filesys_a8ab712f9d961468f5a729eb548dacb77}{is\+\_\+separator}} (wchar\+\_\+t c)
\begin{DoxyCompactList}\small\item\em Checks whether given character is a path separator. \end{DoxyCompactList}\item 
static \mbox{\hyperlink{classfz_1_1local__filesys_a7aead736a07eaf25623ad7bfa1f0ee2d}{type}} \mbox{\hyperlink{classfz_1_1local__filesys_a19164d3d2bd18af1df672338481db4d2}{get\+\_\+file\+\_\+type}} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} const \&path, bool follow\+\_\+links=false)
\begin{DoxyCompactList}\small\item\em Get\+File\+Type return the type of the passed path. \end{DoxyCompactList}\item 
static \mbox{\hyperlink{classfz_1_1local__filesys_a7aead736a07eaf25623ad7bfa1f0ee2d}{type}} \mbox{\hyperlink{classfz_1_1local__filesys_ac5a84563a7a4613dbb40c395f8309528}{get\+\_\+file\+\_\+info}} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} const \&path, bool \&is\+\_\+link, int64\+\_\+t $\ast$size, \mbox{\hyperlink{classfz_1_1datetime}{datetime}} $\ast$modification\+\_\+time, int $\ast$mode)
\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_a2f3b561c346409e9f01f209496b51b6d}\label{classfz_1_1local__filesys_a2f3b561c346409e9f01f209496b51b6d}} 
static int64\+\_\+t \mbox{\hyperlink{classfz_1_1local__filesys_a2f3b561c346409e9f01f209496b51b6d}{get\+\_\+size}} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} const \&path, bool $\ast$is\+\_\+link=nullptr)
\begin{DoxyCompactList}\small\item\em Gets size of file, returns -\/1 on error. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_af2050b26b56b2f6a259b06b17c4ed24b}\label{classfz_1_1local__filesys_af2050b26b56b2f6a259b06b17c4ed24b}} 
static \mbox{\hyperlink{classfz_1_1datetime}{datetime}} {\bfseries get\+\_\+modification\+\_\+time} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} const \&path)
\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_aea7bd9b8e884a8e1ba20d27783f92b0a}\label{classfz_1_1local__filesys_aea7bd9b8e884a8e1ba20d27783f92b0a}} 
static bool {\bfseries set\+\_\+modification\+\_\+time} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} const \&path, const \mbox{\hyperlink{classfz_1_1datetime}{datetime}} \&t)
\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_a971119f5db1b42dcd76e52d965466a3a}\label{classfz_1_1local__filesys_a971119f5db1b42dcd76e52d965466a3a}} 
static \mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} \mbox{\hyperlink{classfz_1_1local__filesys_a971119f5db1b42dcd76e52d965466a3a}{get\+\_\+link\+\_\+target}} (\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} const \&path)
\begin{DoxyCompactList}\small\item\em Get the target path of a symbolic link. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classfz_1_1local__filesys_a599a78ab5d81d21a82107d9d09bf0223}\label{classfz_1_1local__filesys_a599a78ab5d81d21a82107d9d09bf0223}} 
static char const \mbox{\hyperlink{classfz_1_1local__filesys_a599a78ab5d81d21a82107d9d09bf0223}{path\+\_\+separator}}
\begin{DoxyCompactList}\small\item\em The system\textquotesingle{}s preferred path separator. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
This class can be used to enumerate the contents of local directories and to query the metadata of files. 

This class is aware of symbolic links. Under Windows it can handle reparse points as well. \begin{Desc}
\item[Examples]\par
\mbox{\hyperlink{list_8cpp-example}{list.\+cpp}}.\end{Desc}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{classfz_1_1local__filesys_a261d6909a4e7461d5dfc48477a333e91}\label{classfz_1_1local__filesys_a261d6909a4e7461d5dfc48477a333e91}} 
\index{local\_filesys@{local\_filesys}!begin\_find\_files@{begin\_find\_files}}
\index{begin\_find\_files@{begin\_find\_files}!local\_filesys@{local\_filesys}}
\subsubsection{\texorpdfstring{begin\_find\_files()}{begin\_find\_files()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classfz_1_1result}{result}} begin\+\_\+find\+\_\+files (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}}}]{path,  }\item[{bool}]{dirs\+\_\+only = {\ttfamily false} }\end{DoxyParamCaption})}



Begins enumerating a directory. 


\begin{DoxyParams}{Parameters}
{\em dirs\+\_\+only} & If true, only directories are enumerated. \\
\hline
\end{DoxyParams}
\begin{Desc}
\item[Examples]\par
\mbox{\hyperlink{list_8cpp-example}{list.\+cpp}}.\end{Desc}
\mbox{\Hypertarget{classfz_1_1local__filesys_ac5a84563a7a4613dbb40c395f8309528}\label{classfz_1_1local__filesys_ac5a84563a7a4613dbb40c395f8309528}} 
\index{local\_filesys@{local\_filesys}!get\_file\_info@{get\_file\_info}}
\index{get\_file\_info@{get\_file\_info}!local\_filesys@{local\_filesys}}
\subsubsection{\texorpdfstring{get\_file\_info()}{get\_file\_info()}}
{\footnotesize\ttfamily static \mbox{\hyperlink{classfz_1_1local__filesys_a7aead736a07eaf25623ad7bfa1f0ee2d}{type}} get\+\_\+file\+\_\+info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} const \&}]{path,  }\item[{bool \&}]{is\+\_\+link,  }\item[{int64\+\_\+t $\ast$}]{size,  }\item[{\mbox{\hyperlink{classfz_1_1datetime}{datetime}} $\ast$}]{modification\+\_\+time,  }\item[{int $\ast$}]{mode }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}

Gets the info for the passed arguments. Follows symbolic links and stats the target, sets is\+\_\+link to true if path was a link. \mbox{\Hypertarget{classfz_1_1local__filesys_a19164d3d2bd18af1df672338481db4d2}\label{classfz_1_1local__filesys_a19164d3d2bd18af1df672338481db4d2}} 
\index{local\_filesys@{local\_filesys}!get\_file\_type@{get\_file\_type}}
\index{get\_file\_type@{get\_file\_type}!local\_filesys@{local\_filesys}}
\subsubsection{\texorpdfstring{get\_file\_type()}{get\_file\_type()}}
{\footnotesize\ttfamily static \mbox{\hyperlink{classfz_1_1local__filesys_a7aead736a07eaf25623ad7bfa1f0ee2d}{type}} get\+\_\+file\+\_\+type (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} const \&}]{path,  }\item[{bool}]{follow\+\_\+links = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Get\+File\+Type return the type of the passed path. 

Can optionally follow symbolic links. \mbox{\Hypertarget{classfz_1_1local__filesys_a562a4d9c1f276bd203f2acc3793bcebb}\label{classfz_1_1local__filesys_a562a4d9c1f276bd203f2acc3793bcebb}} 
\index{local\_filesys@{local\_filesys}!get\_next\_file@{get\_next\_file}}
\index{get\_next\_file@{get\_next\_file}!local\_filesys@{local\_filesys}}
\subsubsection{\texorpdfstring{get\_next\_file()}{get\_next\_file()}}
{\footnotesize\ttfamily bool get\+\_\+next\+\_\+file (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespacefz_a79dcecd35ee9a55ae1a5afe76d23e9e5}{native\+\_\+string}} \&}]{name,  }\item[{bool \&}]{is\+\_\+link,  }\item[{bool \&}]{is\+\_\+dir,  }\item[{int64\+\_\+t $\ast$}]{size,  }\item[{\mbox{\hyperlink{classfz_1_1datetime}{datetime}} $\ast$}]{modification\+\_\+time,  }\item[{int $\ast$}]{mode }\end{DoxyParamCaption})}

Gets the next file in the directory. Call until it returns false.

Stores the metadata in any non-\/null arguments. \mbox{\Hypertarget{classfz_1_1local__filesys_a8ab712f9d961468f5a729eb548dacb77}\label{classfz_1_1local__filesys_a8ab712f9d961468f5a729eb548dacb77}} 
\index{local\_filesys@{local\_filesys}!is\_separator@{is\_separator}}
\index{is\_separator@{is\_separator}!local\_filesys@{local\_filesys}}
\subsubsection{\texorpdfstring{is\_separator()}{is\_separator()}}
{\footnotesize\ttfamily static bool is\+\_\+separator (\begin{DoxyParamCaption}\item[{wchar\+\_\+t}]{c }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Checks whether given character is a path separator. 

On most systems, the forward slash is the only separator. The exception is Windows where both forward and backward slashes are separators, with the latter being preferred. 

The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{local__filesys_8hpp}{local\+\_\+filesys.\+hpp}}\end{DoxyCompactItemize}