Source code for pyrogram.raw.functions.contacts.search

#  Pyrogram - Telegram MTProto API Client Library for Python
#  Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
#  This file is part of Pyrogram.
#
#  Pyrogram is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Lesser General Public License as published
#  by the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  Pyrogram is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public License
#  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.

from io import BytesIO

from pyrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from pyrogram.raw.core import TLObject
from pyrogram import raw
from typing import List, Optional, Any

# # # # # # # # # # # # # # # # # # # # # # # #
#               !!! WARNING !!!               #
#          This is a generated file!          #
# All changes made in this file will be lost! #
# # # # # # # # # # # # # # # # # # # # # # # #




class Search(TLObject):  # type: ignore
    """Returns users found by username substring.

    .. include:: /_includes/usable-by/users.rst

    Details:
        - Layer: ``229``
        - ID: ``5F58D0F``

    Parameters:
        q (``str``):
            Target substring

        limit (``int`` ``32-bit``):
            Maximum number of users to be returned

        broadcasts (``bool``, *optional*):
            N/A

        bots (``bool``, *optional*):
            N/A

    Returns:
        :obj:`contacts.Found <pyrogram.raw.base.contacts.Found>`
    """

    __slots__: List[str] = ["q", "limit", "broadcasts", "bots"]

    ID = 0x5f58d0f
    QUALNAME = "functions.contacts.Search"

    def __init__(self, *, q: str, limit: int, broadcasts: Optional[bool] = None, bots: Optional[bool] = None) -> None:
        self.q = q  # string
        self.limit = limit  # int
        self.broadcasts = broadcasts  # flags.0?true
        self.bots = bots  # flags.1?true

    @staticmethod
    def read(b: BytesIO, *args: Any) -> "Search":
        
        flags = Int.read(b)
        
        broadcasts = True if flags & (1 << 0) else False
        bots = True if flags & (1 << 1) else False
        q = String.read(b)
        
        limit = Int.read(b)
        
        return Search(q=q, limit=limit, broadcasts=broadcasts, bots=bots)

    def write(self, *args) -> bytes:
        b = BytesIO()
        b.write(Int(self.ID, False))

        flags = 0
        flags |= (1 << 0) if self.broadcasts else 0
        flags |= (1 << 1) if self.bots else 0
        b.write(Int(flags))
        
        b.write(String(self.q))
        
        b.write(Int(self.limit))
        
        return b.getvalue()