td::td_api::readFilePart Class Reference

Inherits td::td_api::Function.

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

Public Member Functions
	readFilePart ()
	readFilePart (int32 file_id_, int53 offset_, int53 count_)
std::int32_t	get_id () const final
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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (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 = 906798861
	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's file system, because it is usually slower than a direct read from the file.

Returns object_ptr<FilePart>.

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

Returns object_ptr<FilePart>.

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'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.

Member Function Documentation

get_id()

std::int32_t td::td_api::readFilePart::get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements td::TlObject.

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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h