tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::readFilePart Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::readFilePart:
td::td_api::Function td::TlObject

Public Types

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

Public Member Functions

 readFilePart ()
 
 readFilePart (int32 file_id_, int53 offset_, int53 count_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::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
 

Public Attributes

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.
 

Static Public Attributes

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

Detailed 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&#x27;s file system, because it is usually slower than a direct read from the file.

Returns object_ptr<Data>.

Definition at line 119167 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 119206 of file td_api.h.

Constructor & Destructor Documentation

◆ readFilePart() [1/2]

td::td_api::readFilePart::readFilePart ( )

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&#x27;s file system, because it is usually slower than a direct read from the file.

Returns object_ptr<Data>.

◆ readFilePart() [2/2]

td::td_api::readFilePart::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&#x27;s file system, because it is usually slower than a direct read from the file.

Returns object_ptr<Data>.

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.

Member Function Documentation

◆ store()

void td::td_api::readFilePart::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 td::TlObject.

Member Data Documentation

◆ count_

int53 td::td_api::readFilePart::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.

Definition at line 119182 of file td_api.h.

◆ file_id_

int32 td::td_api::readFilePart::file_id_

Identifier of the file. The file must be located in the TDLib file cache.

Definition at line 119178 of file td_api.h.

◆ ID

const std::int32_t td::td_api::readFilePart::ID = -174576822
static

Identifier uniquely determining a type of the object.

Definition at line 119203 of file td_api.h.

◆ offset_

int53 td::td_api::readFilePart::offset_

The offset from which to read the file.

Definition at line 119180 of file td_api.h.


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