TDLib
Loading...
Searching...
No Matches
searchStringsByPrefix Class Referencefinal

Inherits Function.

Description

Searches specified query by word prefixes in the provided strings. Returns 0-based positions of strings that matched. Can be called synchronously.

Returns object_ptr<FoundPositions>.

Public Types

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

Public Member Functions

 searchStringsByPrefix ()
 searchStringsByPrefix (array< string > &&strings_, string const &query_, int32 limit_, bool return_none_for_empty_query_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

int32 limit_
 The maximum number of objects to return.
string query_
 Query to search for.
bool return_none_for_empty_query_
 Pass true to receive no results for an empty query.
array< string > strings_
 The strings to search in for the query.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ searchStringsByPrefix() [1/2]

searchStringsByPrefix ( )

Default constructor for a function, which searches specified query by word prefixes in the provided strings. Returns 0-based positions of strings that matched. Can be called synchronously.

Returns object_ptr<FoundPositions>.

◆ searchStringsByPrefix() [2/2]

searchStringsByPrefix ( array< string > && strings_,
string const & query_,
int32 limit_,
bool return_none_for_empty_query_ )

Creates a function, which searches specified query by word prefixes in the provided strings. Returns 0-based positions of strings that matched. Can be called synchronously.

Returns object_ptr<FoundPositions>.

Parameters
[in]strings_The strings to search in for the query.
[in]query_Query to search for.
[in]limit_The maximum number of objects to return.
[in]return_none_for_empty_query_Pass true to receive no results for an empty query.

Member Function 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: