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

Inherits Function.

Description

Reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if the application has no direct access to TDLib's file system, because it is usually slower than a direct read from the file.

Returns object_ptr<FilePart>.

Public Fields

int32 file_id_
 Identifier of the file. The file must be located in the TDLib file cache.
 
int53 offset_
 The offset from which to read the file.
 
int53 count_
 Number of bytes to read. An error will be returned if there are not enough bytes available in the file from the specified position. Pass 0 to read all available data from the specified position.
 

Public Types

using ReturnType = object_ptr< filePart >
 Typedef for the type returned by the function.
 

Public Instance Methods

 readFilePart ()
 
 readFilePart (int32 file_id_, int53 offset_, int53 count_)
 
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 = 906798861
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ readFilePart() [1/2]

Default constructor for a function, which reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if the application has no direct access to TDLib's file system, because it is usually slower than a direct read from the file.

Returns object_ptr<FilePart>.

◆ readFilePart() [2/2]

readFilePart ( int32  file_id_,
int53  offset_,
int53  count_ 
)

Creates a function, which reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if the application has no direct access to TDLib's file system, because it is usually slower than a direct read from the file.

Returns object_ptr<FilePart>.

Parameters
[in]file_id_Identifier of the file. The file must be located in the TDLib file cache.
[in]offset_The offset from which to read the file.
[in]count_Number of bytes to read. An error will be returned if there are not enough bytes available in the file from the specified position. Pass 0 to read all available data from the specified position.

Method Documentation

◆ 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: