List of all members | Public Fields | Public Instance Methods | Static Public Attributes
localFile Class Referencefinal

Inherits Object.

Description

Represents a local file.

Public Fields

string path_
 Local path to the locally available file part; may be empty.
 
bool can_be_downloaded_
 True, if it is possible to download or generate the file.
 
bool can_be_deleted_
 True, if the file can be deleted.
 
bool is_downloading_active_
 True, if the file is currently being downloaded (or a local copy is being generated by some other means).
 
bool is_downloading_completed_
 True, if the local copy is fully available.
 
int32 download_offset_
 Download will be started from this offset. downloaded_prefix_size is calculated from this offset.
 
int32 downloaded_prefix_size_
 If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes.
 
int32 downloaded_size_
 Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage.
 

Public Instance Methods

 localFile ()
 
 localFile (string const &path_, bool can_be_downloaded_, bool can_be_deleted_, bool is_downloading_active_, bool is_downloading_completed_, int32 download_offset_, int32 downloaded_prefix_size_, int32 downloaded_size_)
 
std::int32_t get_id () const final
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -1166400317
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ localFile() [1/2]

localFile ( )

Represents a local file.

◆ localFile() [2/2]

localFile ( string const &  path_,
bool  can_be_downloaded_,
bool  can_be_deleted_,
bool  is_downloading_active_,
bool  is_downloading_completed_,
int32  download_offset_,
int32  downloaded_prefix_size_,
int32  downloaded_size_ 
)

Represents a local file.

Parameters
[in]path_Local path to the locally available file part; may be empty.
[in]can_be_downloaded_True, if it is possible to download or generate the file.
[in]can_be_deleted_True, if the file can be deleted.
[in]is_downloading_active_True, if the file is currently being downloaded (or a local copy is being generated by some other means).
[in]is_downloading_completed_True, if the local copy is fully available.
[in]download_offset_Download will be started from this offset. downloaded_prefix_size is calculated from this offset.
[in]downloaded_prefix_size_If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes.
[in]downloaded_size_Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

◆ store()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


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