Source File
	tl_auth_sent_code_gen.go

Belonging Package
	github.com/gotd/td/tg

// Code generated by gotdgen, DO NOT EDIT.

package tg

import (
	"context"
	"errors"
	"fmt"
	"sort"
	"strings"

	"go.uber.org/multierr"

	"github.com/gotd/td/bin"
	"github.com/gotd/td/tdjson"
	"github.com/gotd/td/tdp"
	"github.com/gotd/td/tgerr"
)

// No-op definition for keeping imports.
var (
	_ = bin.Buffer{}
	_ = context.Background()
	_ = fmt.Stringer(nil)
	_ = strings.Builder{}
	_ = errors.Is
	_ = multierr.AppendInto
	_ = sort.Ints
	_ = tdp.Format
	_ = tgerr.Error{}
	_ = tdjson.Encoder{}
)

// AuthSentCode represents TL type `auth.sentCode#5e002502`.
// Contains info about a sent verification code.
//
// See https://core.telegram.org/constructor/auth.sentCode for reference.
type AuthSentCode struct {
	// Flags, see TL conditional fields¹
	//
	// Links:
	//  1) https://core.telegram.org/mtproto/TL-combinators#conditional-fields
	Flags bin.Fields
	// Phone code type
	Type AuthSentCodeTypeClass
	// Phone code hash, to be stored and later re-used with auth.signIn¹
	//
	// Links:
	//  1) https://core.telegram.org/method/auth.signIn
	PhoneCodeHash string
	// Phone code type that will be sent next, if the phone code is not received within
	// timeout seconds: to send it use auth.resendCode¹
	//
	// Links:
	//  1) https://core.telegram.org/method/auth.resendCode
	//
	// Use SetNextType and GetNextType helpers.
	NextType AuthCodeTypeClass
	// Timeout for reception of the phone code
	//
	// Use SetTimeout and GetTimeout helpers.
	Timeout int
}

// AuthSentCodeTypeID is TL type id of AuthSentCode.
const AuthSentCodeTypeID = 0x5e002502

// construct implements constructor of AuthSentCodeClass.
func (s AuthSentCode) construct() AuthSentCodeClass { return &s }

// Ensuring interfaces in compile-time for AuthSentCode.
var (
	_ bin.Encoder     = &AuthSentCode{}
	_ bin.Decoder     = &AuthSentCode{}
	_ bin.BareEncoder = &AuthSentCode{}
	_ bin.BareDecoder = &AuthSentCode{}

	_ AuthSentCodeClass = &AuthSentCode{}
)

func (s *AuthSentCode) Zero() bool {
	if s == nil {
		return true
	}
	if !(s.Flags.Zero()) {
		return false
	}
	if !(s.Type == nil) {
		return false
	}
	if !(s.PhoneCodeHash == "") {
		return false
	}
	if !(s.NextType == nil) {
		return false
	}
	if !(s.Timeout == 0) {
		return false
	}

	return true
}

// String implements fmt.Stringer.
func (s *AuthSentCode) String() string {
	if s == nil {
		return "AuthSentCode(nil)"
	}
	type Alias AuthSentCode
	return fmt.Sprintf("AuthSentCode%+v", Alias(*s))
}

// FillFrom fills AuthSentCode from given interface.
func (s *AuthSentCode) FillFrom(from interface {
	GetType() (value AuthSentCodeTypeClass)
	GetPhoneCodeHash() (value string)
	GetNextType() (value AuthCodeTypeClass, ok bool)
	GetTimeout() (value int, ok bool)
}) {
	s.Type = from.GetType()
	s.PhoneCodeHash = from.GetPhoneCodeHash()
	if val, ok := from.GetNextType(); ok {
		s.NextType = val
	}

	if val, ok := from.GetTimeout(); ok {
		s.Timeout = val
	}

}

// TypeID returns type id in TL schema.
//
// See https://core.telegram.org/mtproto/TL-tl#remarks.
func (*AuthSentCode) TypeID() uint32 {
	return AuthSentCodeTypeID
}

// TypeName returns name of type in TL schema.
func (*AuthSentCode) TypeName() string {
	return "auth.sentCode"
}

// TypeInfo returns info about TL type.
func (s *AuthSentCode) TypeInfo() tdp.Type {
	typ := tdp.Type{
		Name: "auth.sentCode",
		ID:   AuthSentCodeTypeID,
	}
	if s == nil {
		typ.Null = true
		return typ
	}
	typ.Fields = []tdp.Field{
		{
			Name:       "Type",
			SchemaName: "type",
		},
		{
			Name:       "PhoneCodeHash",
			SchemaName: "phone_code_hash",
		},
		{
			Name:       "NextType",
			SchemaName: "next_type",
			Null:       !s.Flags.Has(1),
		},
		{
			Name:       "Timeout",
			SchemaName: "timeout",
			Null:       !s.Flags.Has(2),
		},
	}
	return typ
}

// SetFlags sets flags for non-zero fields.
func (s *AuthSentCode) SetFlags() {
	if !(s.NextType == nil) {
		s.Flags.Set(1)
	}
	if !(s.Timeout == 0) {
		s.Flags.Set(2)
	}
}

// Encode implements bin.Encoder.
func (s *AuthSentCode) Encode(b *bin.Buffer) error {
	if s == nil {
		return fmt.Errorf("can't encode auth.sentCode#5e002502 as nil")
	}
	b.PutID(AuthSentCodeTypeID)
	return s.EncodeBare(b)
}

// EncodeBare implements bin.BareEncoder.
func (s *AuthSentCode) EncodeBare(b *bin.Buffer) error {
	if s == nil {
		return fmt.Errorf("can't encode auth.sentCode#5e002502 as nil")
	}
	s.SetFlags()
	if err := s.Flags.Encode(b); err != nil {
		return fmt.Errorf("unable to encode auth.sentCode#5e002502: field flags: %w", err)
	}
	if s.Type == nil {
		return fmt.Errorf("unable to encode auth.sentCode#5e002502: field type is nil")
	}
	if err := s.Type.Encode(b); err != nil {
		return fmt.Errorf("unable to encode auth.sentCode#5e002502: field type: %w", err)
	}
	b.PutString(s.PhoneCodeHash)
	if s.Flags.Has(1) {
		if s.NextType == nil {
			return fmt.Errorf("unable to encode auth.sentCode#5e002502: field next_type is nil")
		}
		if err := s.NextType.Encode(b); err != nil {
			return fmt.Errorf("unable to encode auth.sentCode#5e002502: field next_type: %w", err)
		}
	}
	if s.Flags.Has(2) {
		b.PutInt(s.Timeout)
	}
	return nil
}

// Decode implements bin.Decoder.
func (s *AuthSentCode) Decode(b *bin.Buffer) error {
	if s == nil {
		return fmt.Errorf("can't decode auth.sentCode#5e002502 to nil")
	}
	if err := b.ConsumeID(AuthSentCodeTypeID); err != nil {
		return fmt.Errorf("unable to decode auth.sentCode#5e002502: %w", err)
	}
	return s.DecodeBare(b)
}

// DecodeBare implements bin.BareDecoder.
func (s *AuthSentCode) DecodeBare(b *bin.Buffer) error {
	if s == nil {
		return fmt.Errorf("can't decode auth.sentCode#5e002502 to nil")
	}
	{
		if err := s.Flags.Decode(b); err != nil {
			return fmt.Errorf("unable to decode auth.sentCode#5e002502: field flags: %w", err)
		}
	}
	{
		value, err := DecodeAuthSentCodeType(b)
		if err != nil {
			return fmt.Errorf("unable to decode auth.sentCode#5e002502: field type: %w", err)
		}
		s.Type = value
	}
	{
		value, err := b.String()
		if err != nil {
			return fmt.Errorf("unable to decode auth.sentCode#5e002502: field phone_code_hash: %w", err)
		}
		s.PhoneCodeHash = value
	}
	if s.Flags.Has(1) {
		value, err := DecodeAuthCodeType(b)
		if err != nil {
			return fmt.Errorf("unable to decode auth.sentCode#5e002502: field next_type: %w", err)
		}
		s.NextType = value
	}
	if s.Flags.Has(2) {
		value, err := b.Int()
		if err != nil {
			return fmt.Errorf("unable to decode auth.sentCode#5e002502: field timeout: %w", err)
		}
		s.Timeout = value
	}
	return nil
}

// GetType returns value of Type field.
func (s *AuthSentCode) GetType() (value AuthSentCodeTypeClass) {
	if s == nil {
		return
	}
	return s.Type
}

// GetPhoneCodeHash returns value of PhoneCodeHash field.
func (s *AuthSentCode) GetPhoneCodeHash() (value string) {
	if s == nil {
		return
	}
	return s.PhoneCodeHash
}

// SetNextType sets value of NextType conditional field.
func (s *AuthSentCode) SetNextType(value AuthCodeTypeClass) {
	s.Flags.Set(1)
	s.NextType = value
}

// GetNextType returns value of NextType conditional field and
// boolean which is true if field was set.
func (s *AuthSentCode) GetNextType() (value AuthCodeTypeClass, ok bool) {
	if s == nil {
		return
	}
	if !s.Flags.Has(1) {
		return value, false
	}
	return s.NextType, true
}

// SetTimeout sets value of Timeout conditional field.
func (s *AuthSentCode) SetTimeout(value int) {
	s.Flags.Set(2)
	s.Timeout = value
}

// GetTimeout returns value of Timeout conditional field and
// boolean which is true if field was set.
func (s *AuthSentCode) GetTimeout() (value int, ok bool) {
	if s == nil {
		return
	}
	if !s.Flags.Has(2) {
		return value, false
	}
	return s.Timeout, true
}

// AuthSentCodeSuccess represents TL type `auth.sentCodeSuccess#2390fe44`.
// The user successfully authorized using future auth tokens¹
//
// Links:
//  1. https://core.telegram.org/api/auth#future-auth-tokens
//
// See https://core.telegram.org/constructor/auth.sentCodeSuccess for reference.
type AuthSentCodeSuccess struct {
	// Authorization info
	Authorization AuthAuthorizationClass
}

// AuthSentCodeSuccessTypeID is TL type id of AuthSentCodeSuccess.
const AuthSentCodeSuccessTypeID = 0x2390fe44

// construct implements constructor of AuthSentCodeClass.
func (s AuthSentCodeSuccess) construct() AuthSentCodeClass { return &s }

// Ensuring interfaces in compile-time for AuthSentCodeSuccess.
var (
	_ bin.Encoder     = &AuthSentCodeSuccess{}
	_ bin.Decoder     = &AuthSentCodeSuccess{}
	_ bin.BareEncoder = &AuthSentCodeSuccess{}
	_ bin.BareDecoder = &AuthSentCodeSuccess{}

	_ AuthSentCodeClass = &AuthSentCodeSuccess{}
)

func (s *AuthSentCodeSuccess) Zero() bool {
	if s == nil {
		return true
	}
	if !(s.Authorization == nil) {
		return false
	}

	return true
}

// String implements fmt.Stringer.
func (s *AuthSentCodeSuccess) String() string {
	if s == nil {
		return "AuthSentCodeSuccess(nil)"
	}
	type Alias AuthSentCodeSuccess
	return fmt.Sprintf("AuthSentCodeSuccess%+v", Alias(*s))
}

// FillFrom fills AuthSentCodeSuccess from given interface.
func (s *AuthSentCodeSuccess) FillFrom(from interface {
	GetAuthorization() (value AuthAuthorizationClass)
}) {
	s.Authorization = from.GetAuthorization()
}

// TypeID returns type id in TL schema.
//
// See https://core.telegram.org/mtproto/TL-tl#remarks.
func (*AuthSentCodeSuccess) TypeID() uint32 {
	return AuthSentCodeSuccessTypeID
}

// TypeName returns name of type in TL schema.
func (*AuthSentCodeSuccess) TypeName() string {
	return "auth.sentCodeSuccess"
}

// TypeInfo returns info about TL type.
func (s *AuthSentCodeSuccess) TypeInfo() tdp.Type {
	typ := tdp.Type{
		Name: "auth.sentCodeSuccess",
		ID:   AuthSentCodeSuccessTypeID,
	}
	if s == nil {
		typ.Null = true
		return typ
	}
	typ.Fields = []tdp.Field{
		{
			Name:       "Authorization",
			SchemaName: "authorization",
		},
	}
	return typ
}

// Encode implements bin.Encoder.
func (s *AuthSentCodeSuccess) Encode(b *bin.Buffer) error {
	if s == nil {
		return fmt.Errorf("can't encode auth.sentCodeSuccess#2390fe44 as nil")
	}
	b.PutID(AuthSentCodeSuccessTypeID)
	return s.EncodeBare(b)
}

// EncodeBare implements bin.BareEncoder.
func (s *AuthSentCodeSuccess) EncodeBare(b *bin.Buffer) error {
	if s == nil {
		return fmt.Errorf("can't encode auth.sentCodeSuccess#2390fe44 as nil")
	}
	if s.Authorization == nil {
		return fmt.Errorf("unable to encode auth.sentCodeSuccess#2390fe44: field authorization is nil")
	}
	if err := s.Authorization.Encode(b); err != nil {
		return fmt.Errorf("unable to encode auth.sentCodeSuccess#2390fe44: field authorization: %w", err)
	}
	return nil
}

// Decode implements bin.Decoder.
func (s *AuthSentCodeSuccess) Decode(b *bin.Buffer) error {
	if s == nil {
		return fmt.Errorf("can't decode auth.sentCodeSuccess#2390fe44 to nil")
	}
	if err := b.ConsumeID(AuthSentCodeSuccessTypeID); err != nil {
		return fmt.Errorf("unable to decode auth.sentCodeSuccess#2390fe44: %w", err)
	}
	return s.DecodeBare(b)
}

// DecodeBare implements bin.BareDecoder.
func (s *AuthSentCodeSuccess) DecodeBare(b *bin.Buffer) error {
	if s == nil {
		return fmt.Errorf("can't decode auth.sentCodeSuccess#2390fe44 to nil")
	}
	{
		value, err := DecodeAuthAuthorization(b)
		if err != nil {
			return fmt.Errorf("unable to decode auth.sentCodeSuccess#2390fe44: field authorization: %w", err)
		}
		s.Authorization = value
	}
	return nil
}

// GetAuthorization returns value of Authorization field.
func (s *AuthSentCodeSuccess) GetAuthorization() (value AuthAuthorizationClass) {
	if s == nil {
		return
	}
	return s.Authorization
}

// AuthSentCodeClassName is schema name of AuthSentCodeClass.
const AuthSentCodeClassName = "auth.SentCode"

// AuthSentCodeClass represents auth.SentCode generic type.
//
// See https://core.telegram.org/type/auth.SentCode for reference.
//
// Example:
//
//	g, err := tg.DecodeAuthSentCode(buf)
//	if err != nil {
//	    panic(err)
//	}
//	switch v := g.(type) {
//	case *tg.AuthSentCode: // auth.sentCode#5e002502
//	case *tg.AuthSentCodeSuccess: // auth.sentCodeSuccess#2390fe44
//	default: panic(v)
//	}
type AuthSentCodeClass interface {
	bin.Encoder
	bin.Decoder
	bin.BareEncoder
	bin.BareDecoder
	construct() AuthSentCodeClass

	// TypeID returns type id in TL schema.
	//
	// See https://core.telegram.org/mtproto/TL-tl#remarks.
	TypeID() uint32
	// TypeName returns name of type in TL schema.
	TypeName() string
	// String implements fmt.Stringer.
	String() string
	// Zero returns true if current object has a zero value.
	Zero() bool
}

// DecodeAuthSentCode implements binary de-serialization for AuthSentCodeClass.
func DecodeAuthSentCode(buf *bin.Buffer) (AuthSentCodeClass, error) {
	id, err := buf.PeekID()
	if err != nil {
		return nil, err
	}
	switch id {
	case AuthSentCodeTypeID:
		// Decoding auth.sentCode#5e002502.
		v := AuthSentCode{}
		if err := v.Decode(buf); err != nil {
			return nil, fmt.Errorf("unable to decode AuthSentCodeClass: %w", err)
		}
		return &v, nil
	case AuthSentCodeSuccessTypeID:
		// Decoding auth.sentCodeSuccess#2390fe44.
		v := AuthSentCodeSuccess{}
		if err := v.Decode(buf); err != nil {
			return nil, fmt.Errorf("unable to decode AuthSentCodeClass: %w", err)
		}
		return &v, nil
	default:
		return nil, fmt.Errorf("unable to decode AuthSentCodeClass: %w", bin.NewUnexpectedID(id))
	}
}

// AuthSentCode boxes the AuthSentCodeClass providing a helper.
type AuthSentCodeBox struct {
	SentCode AuthSentCodeClass
}

// Decode implements bin.Decoder for AuthSentCodeBox.
func (b *AuthSentCodeBox) Decode(buf *bin.Buffer) error {
	if b == nil {
		return fmt.Errorf("unable to decode AuthSentCodeBox to nil")
	}
	v, err := DecodeAuthSentCode(buf)
	if err != nil {
		return fmt.Errorf("unable to decode boxed value: %w", err)
	}
	b.SentCode = v
	return nil
}

// Encode implements bin.Encode for AuthSentCodeBox.
func (b *AuthSentCodeBox) Encode(buf *bin.Buffer) error {
	if b == nil || b.SentCode == nil {
		return fmt.Errorf("unable to encode AuthSentCodeClass as nil")
	}
	return b.SentCode.Encode(buf)
}

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.