Class: RESTFramework::BasePaginator

Inherits:

Object

• Object
• RESTFramework::BasePaginator

Defined in:

lib/rest_framework/paginators.rb

Direct Known Subclasses

PageNumberPaginator

Instance Method Summary

• #get_page ⇒ Object

  Get the page and return it so the caller can serialize it.

• #get_paginated_response(serialized_page) ⇒ Object

  Wrap the serialized page with appropriate metadata.

• #initialize(data:, controller:, **kwargs) ⇒ BasePaginator constructor

  A new instance of BasePaginator.

Constructor Details

#initialize(data:, controller:, **kwargs) ⇒ BasePaginator

Returns a new instance of BasePaginator.

# File 'lib/rest_framework/paginators.rb', line 2

def initialize(data:, controller:, **kwargs)
  @data = data
  @controller = controller
end

Instance Method Details

#get_page ⇒ Object

Get the page and return it so the caller can serialize it.

Raises:

• (NotImplementedError)

# File 'lib/rest_framework/paginators.rb', line 8

def get_page
  raise NotImplementedError
end

#get_paginated_response(serialized_page) ⇒ Object

Wrap the serialized page with appropriate metadata.

Raises:

• (NotImplementedError)

# File 'lib/rest_framework/paginators.rb', line 13

def get_paginated_response(serialized_page)
  raise NotImplementedError
end