Lean  $LEAN_TAG$
Public Member Functions | List of all members
QuantConnect.Lean.Engine.Storage.FileHandler Class Reference

Raw file handler More...

Public Member Functions

virtual bool Exists (string path)
 True if the given file path exists More...
 
virtual void Delete (string path)
 Will delete the given file path More...
 
virtual void WriteAllBytes (string path, byte[] data)
 Will write the given byte array at the target file path More...
 
virtual byte[] ReadAllBytes (string path)
 Read all bytes in the given file path More...
 
virtual long TryGetFileLength (string path)
 Will try to fetch the given file length, will return 0 if it doesn't exist More...
 
virtual bool DirectoryExists (string path)
 True if the given directory exists More...
 
virtual DirectoryInfo CreateDirectory (string path)
 Create the requested directory path More...
 
virtual IEnumerable< FileInfo > EnumerateFiles (string path, string pattern, SearchOption searchOption, out string rootfolder)
 Enumerate the files in the target path More...
 

Detailed Description

Raw file handler

Useful to abstract file operations for LocalObjectStore

Definition at line 25 of file FileHandler.cs.

Member Function Documentation

◆ Exists()

virtual bool QuantConnect.Lean.Engine.Storage.FileHandler.Exists ( string  path)
virtual

True if the given file path exists

Definition at line 30 of file FileHandler.cs.

Here is the caller graph for this function:

◆ Delete()

virtual void QuantConnect.Lean.Engine.Storage.FileHandler.Delete ( string  path)
virtual

Will delete the given file path

Definition at line 38 of file FileHandler.cs.

Here is the caller graph for this function:

◆ WriteAllBytes()

virtual void QuantConnect.Lean.Engine.Storage.FileHandler.WriteAllBytes ( string  path,
byte[]  data 
)
virtual

Will write the given byte array at the target file path

Definition at line 46 of file FileHandler.cs.

Here is the caller graph for this function:

◆ ReadAllBytes()

virtual byte [] QuantConnect.Lean.Engine.Storage.FileHandler.ReadAllBytes ( string  path)
virtual

Read all bytes in the given file path

Definition at line 54 of file FileHandler.cs.

◆ TryGetFileLength()

virtual long QuantConnect.Lean.Engine.Storage.FileHandler.TryGetFileLength ( string  path)
virtual

Will try to fetch the given file length, will return 0 if it doesn't exist

Definition at line 62 of file FileHandler.cs.

Here is the caller graph for this function:

◆ DirectoryExists()

virtual bool QuantConnect.Lean.Engine.Storage.FileHandler.DirectoryExists ( string  path)
virtual

True if the given directory exists

Definition at line 75 of file FileHandler.cs.

Here is the caller graph for this function:

◆ CreateDirectory()

virtual DirectoryInfo QuantConnect.Lean.Engine.Storage.FileHandler.CreateDirectory ( string  path)
virtual

Create the requested directory path

Definition at line 83 of file FileHandler.cs.

Here is the caller graph for this function:

◆ EnumerateFiles()

virtual IEnumerable<FileInfo> QuantConnect.Lean.Engine.Storage.FileHandler.EnumerateFiles ( string  path,
string  pattern,
SearchOption  searchOption,
out string  rootfolder 
)
virtual

Enumerate the files in the target path

Definition at line 91 of file FileHandler.cs.

The documentation for this class was generated from the following file: