mautrix-telegram/pkg/gotd/tg/tl_messages_translate_text_gen.go

// Code generated by gotdgen, DO NOT EDIT.

package tg

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

	"go.uber.org/multierr"

	"go.mau.fi/mautrix-telegram/pkg/gotd/bin"
	"go.mau.fi/mautrix-telegram/pkg/gotd/tdjson"
	"go.mau.fi/mautrix-telegram/pkg/gotd/tdp"
	"go.mau.fi/mautrix-telegram/pkg/gotd/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{}
)

// MessagesTranslateTextRequest represents TL type `messages.translateText#a5eec345`.
// Translate a given text.
// Styled text entities¹ will only be preserved for Telegram Premium² users.
//
// Links:
//  1. https://core.telegram.org/api/entities
//  2. https://core.telegram.org/api/premium
//
// See https://core.telegram.org/method/messages.translateText for reference.
type MessagesTranslateTextRequest struct {
	// Flags, see TL conditional fields¹
	//
	// Links:
	//  1) https://core.telegram.org/mtproto/TL-combinators#conditional-fields
	Flags bin.Fields
	// If the text is a chat message, the peer ID
	//
	// Use SetPeer and GetPeer helpers.
	Peer InputPeerClass
	// A list of message IDs to translate
	//
	// Use SetID and GetID helpers.
	ID []int
	// A list of styled messages to translate
	//
	// Use SetText and GetText helpers.
	Text []TextWithEntities
	// Two-letter ISO 639-1 language code of the language to which the message is translated
	ToLang string
	// Tone field of MessagesTranslateTextRequest.
	//
	// Use SetTone and GetTone helpers.
	Tone string
}

// MessagesTranslateTextRequestTypeID is TL type id of MessagesTranslateTextRequest.
const MessagesTranslateTextRequestTypeID = 0xa5eec345

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

func (t *MessagesTranslateTextRequest) Zero() bool {
	if t == nil {
		return true
	}
	if !(t.Flags.Zero()) {
		return false
	}
	if !(t.Peer == nil) {
		return false
	}
	if !(t.ID == nil) {
		return false
	}
	if !(t.Text == nil) {
		return false
	}
	if !(t.ToLang == "") {
		return false
	}
	if !(t.Tone == "") {
		return false
	}

	return true
}

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

// FillFrom fills MessagesTranslateTextRequest from given interface.
func (t *MessagesTranslateTextRequest) FillFrom(from interface {
	GetPeer() (value InputPeerClass, ok bool)
	GetID() (value []int, ok bool)
	GetText() (value []TextWithEntities, ok bool)
	GetToLang() (value string)
	GetTone() (value string, ok bool)
}) {
	if val, ok := from.GetPeer(); ok {
		t.Peer = val
	}

	if val, ok := from.GetID(); ok {
		t.ID = val
	}

	if val, ok := from.GetText(); ok {
		t.Text = val
	}

	t.ToLang = from.GetToLang()
	if val, ok := from.GetTone(); ok {
		t.Tone = val
	}

}

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

// TypeName returns name of type in TL schema.
func (*MessagesTranslateTextRequest) TypeName() string {
	return "messages.translateText"
}

// TypeInfo returns info about TL type.
func (t *MessagesTranslateTextRequest) TypeInfo() tdp.Type {
	typ := tdp.Type{
		Name: "messages.translateText",
		ID:   MessagesTranslateTextRequestTypeID,
	}
	if t == nil {
		typ.Null = true
		return typ
	}
	typ.Fields = []tdp.Field{
		{
			Name:       "Peer",
			SchemaName: "peer",
			Null:       !t.Flags.Has(0),
		},
		{
			Name:       "ID",
			SchemaName: "id",
			Null:       !t.Flags.Has(0),
		},
		{
			Name:       "Text",
			SchemaName: "text",
			Null:       !t.Flags.Has(1),
		},
		{
			Name:       "ToLang",
			SchemaName: "to_lang",
		},
		{
			Name:       "Tone",
			SchemaName: "tone",
			Null:       !t.Flags.Has(2),
		},
	}
	return typ
}

// SetFlags sets flags for non-zero fields.
func (t *MessagesTranslateTextRequest) SetFlags() {
	if !(t.Peer == nil) {
		t.Flags.Set(0)
	}
	if !(t.ID == nil) {
		t.Flags.Set(0)
	}
	if !(t.Text == nil) {
		t.Flags.Set(1)
	}
	if !(t.Tone == "") {
		t.Flags.Set(2)
	}
}

// Encode implements bin.Encoder.
func (t *MessagesTranslateTextRequest) Encode(b *bin.Buffer) error {
	if t == nil {
		return fmt.Errorf("can't encode messages.translateText#a5eec345 as nil")
	}
	b.PutID(MessagesTranslateTextRequestTypeID)
	return t.EncodeBare(b)
}

// EncodeBare implements bin.BareEncoder.
func (t *MessagesTranslateTextRequest) EncodeBare(b *bin.Buffer) error {
	if t == nil {
		return fmt.Errorf("can't encode messages.translateText#a5eec345 as nil")
	}
	t.SetFlags()
	if err := t.Flags.Encode(b); err != nil {
		return fmt.Errorf("unable to encode messages.translateText#a5eec345: field flags: %w", err)
	}
	if t.Flags.Has(0) {
		if t.Peer == nil {
			return fmt.Errorf("unable to encode messages.translateText#a5eec345: field peer is nil")
		}
		if err := t.Peer.Encode(b); err != nil {
			return fmt.Errorf("unable to encode messages.translateText#a5eec345: field peer: %w", err)
		}
	}
	if t.Flags.Has(0) {
		b.PutVectorHeader(len(t.ID))
		for _, v := range t.ID {
			b.PutInt(v)
		}
	}
	if t.Flags.Has(1) {
		b.PutVectorHeader(len(t.Text))
		for idx, v := range t.Text {
			if err := v.Encode(b); err != nil {
				return fmt.Errorf("unable to encode messages.translateText#a5eec345: field text element with index %d: %w", idx, err)
			}
		}
	}
	b.PutString(t.ToLang)
	if t.Flags.Has(2) {
		b.PutString(t.Tone)
	}
	return nil
}

// Decode implements bin.Decoder.
func (t *MessagesTranslateTextRequest) Decode(b *bin.Buffer) error {
	if t == nil {
		return fmt.Errorf("can't decode messages.translateText#a5eec345 to nil")
	}
	if err := b.ConsumeID(MessagesTranslateTextRequestTypeID); err != nil {
		return fmt.Errorf("unable to decode messages.translateText#a5eec345: %w", err)
	}
	return t.DecodeBare(b)
}

// DecodeBare implements bin.BareDecoder.
func (t *MessagesTranslateTextRequest) DecodeBare(b *bin.Buffer) error {
	if t == nil {
		return fmt.Errorf("can't decode messages.translateText#a5eec345 to nil")
	}
	{
		if err := t.Flags.Decode(b); err != nil {
			return fmt.Errorf("unable to decode messages.translateText#a5eec345: field flags: %w", err)
		}
	}
	if t.Flags.Has(0) {
		value, err := DecodeInputPeer(b)
		if err != nil {
			return fmt.Errorf("unable to decode messages.translateText#a5eec345: field peer: %w", err)
		}
		t.Peer = value
	}
	if t.Flags.Has(0) {
		headerLen, err := b.VectorHeader()
		if err != nil {
			return fmt.Errorf("unable to decode messages.translateText#a5eec345: field id: %w", err)
		}

		if headerLen > 0 {
			t.ID = make([]int, 0, headerLen%bin.PreallocateLimit)
		}
		for idx := 0; idx < headerLen; idx++ {
			value, err := b.Int()
			if err != nil {
				return fmt.Errorf("unable to decode messages.translateText#a5eec345: field id: %w", err)
			}
			t.ID = append(t.ID, value)
		}
	}
	if t.Flags.Has(1) {
		headerLen, err := b.VectorHeader()
		if err != nil {
			return fmt.Errorf("unable to decode messages.translateText#a5eec345: field text: %w", err)
		}

		if headerLen > 0 {
			t.Text = make([]TextWithEntities, 0, headerLen%bin.PreallocateLimit)
		}
		for idx := 0; idx < headerLen; idx++ {
			var value TextWithEntities
			if err := value.Decode(b); err != nil {
				return fmt.Errorf("unable to decode messages.translateText#a5eec345: field text: %w", err)
			}
			t.Text = append(t.Text, value)
		}
	}
	{
		value, err := b.String()
		if err != nil {
			return fmt.Errorf("unable to decode messages.translateText#a5eec345: field to_lang: %w", err)
		}
		t.ToLang = value
	}
	if t.Flags.Has(2) {
		value, err := b.String()
		if err != nil {
			return fmt.Errorf("unable to decode messages.translateText#a5eec345: field tone: %w", err)
		}
		t.Tone = value
	}
	return nil
}

// SetPeer sets value of Peer conditional field.
func (t *MessagesTranslateTextRequest) SetPeer(value InputPeerClass) {
	t.Flags.Set(0)
	t.Peer = value
}

// GetPeer returns value of Peer conditional field and
// boolean which is true if field was set.
func (t *MessagesTranslateTextRequest) GetPeer() (value InputPeerClass, ok bool) {
	if t == nil {
		return
	}
	if !t.Flags.Has(0) {
		return value, false
	}
	return t.Peer, true
}

// SetID sets value of ID conditional field.
func (t *MessagesTranslateTextRequest) SetID(value []int) {
	t.Flags.Set(0)
	t.ID = value
}

// GetID returns value of ID conditional field and
// boolean which is true if field was set.
func (t *MessagesTranslateTextRequest) GetID() (value []int, ok bool) {
	if t == nil {
		return
	}
	if !t.Flags.Has(0) {
		return value, false
	}
	return t.ID, true
}

// SetText sets value of Text conditional field.
func (t *MessagesTranslateTextRequest) SetText(value []TextWithEntities) {
	t.Flags.Set(1)
	t.Text = value
}

// GetText returns value of Text conditional field and
// boolean which is true if field was set.
func (t *MessagesTranslateTextRequest) GetText() (value []TextWithEntities, ok bool) {
	if t == nil {
		return
	}
	if !t.Flags.Has(1) {
		return value, false
	}
	return t.Text, true
}

// GetToLang returns value of ToLang field.
func (t *MessagesTranslateTextRequest) GetToLang() (value string) {
	if t == nil {
		return
	}
	return t.ToLang
}

// SetTone sets value of Tone conditional field.
func (t *MessagesTranslateTextRequest) SetTone(value string) {
	t.Flags.Set(2)
	t.Tone = value
}

// GetTone returns value of Tone conditional field and
// boolean which is true if field was set.
func (t *MessagesTranslateTextRequest) GetTone() (value string, ok bool) {
	if t == nil {
		return
	}
	if !t.Flags.Has(2) {
		return value, false
	}
	return t.Tone, true
}

// MessagesTranslateText invokes method messages.translateText#a5eec345 returning error if any.
// Translate a given text.
// Styled text entities¹ will only be preserved for Telegram Premium² users.
//
// Links:
//  1. https://core.telegram.org/api/entities
//  2. https://core.telegram.org/api/premium
//
// Possible errors:
//
//	400 INPUT_TEXT_EMPTY: The specified text is empty.
//	400 INPUT_TEXT_TOO_LONG: The specified text is too long.
//	400 MSG_ID_INVALID: Invalid message ID provided.
//	400 PEER_ID_INVALID: The provided peer id is invalid.
//	400 TO_LANG_INVALID: The specified destination language is invalid.
//	500 TRANSLATE_REQ_FAILED: Translation failed, please try again later.
//	400 TRANSLATE_REQ_QUOTA_EXCEEDED: Translation is currently unavailable due to a temporary server-side lack of resources.
//	406 TRANSLATIONS_DISABLED: Translations are unavailable, a detailed and localized description for the error will be emitted via an updateServiceNotification as specified here ».
//	500 TRANSLATION_TIMEOUT: A timeout occurred while translating the specified text.
//
// See https://core.telegram.org/method/messages.translateText for reference.
func (c *Client) MessagesTranslateText(ctx context.Context, request *MessagesTranslateTextRequest) (*MessagesTranslateResult, error) {
	var result MessagesTranslateResult

	if err := c.rpc.Invoke(ctx, request, &result); err != nil {
		return nil, err
	}
	return &result, nil
}