// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2024-07-22

package src

// Paginator
// is a paginator struct for response.
//
//  {
//      "body": [
//           {
//               ...
//           },
//           {
//               ...
//           }
//      ],
//      "paging": {
//          ...
//      }
//  }
type Paginator struct {
	Body   any     `json:"body" xml:"body"`
	Paging *Paging `json:"paging" xml:"paging"`
}

// NewPaginator
// creates a paginator response struct.
func NewPaginator(body any, total int64, page, size int) *Paginator {
	if body == nil {
		body = []any{}
	}

	return &Paginator{
		Body:   body,
		Paging: NewPaging(total, page, size),
	}
}