commonMain.com.skydoves.sandwich.mappers.ApiSuccessModelMapper.kt Maven / Gradle / Ivy

Go to download
/*
 * Designed and developed by 2020 skydoves (Jaewoong Eum)
 *
 * 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.
 */
package com.skydoves.sandwich.mappers

import com.skydoves.sandwich.ApiResponse

/**
 * @author skydoves (Jaewoong Eum)
 *
 * A mapper interface for mapping [ApiResponse.Success] response as a custom [V] instance model.
 *
 * @see [ApiSuccessModelMapper](https://github.com/skydoves/sandwich#apisuccessmodelmapper)
 */
public fun interface ApiSuccessModelMapper {

  /**
   * maps the [ApiResponse.Success] to the [V] using the mapper.
   *
   * @param apiSuccessResponse The [ApiResponse.Success] response from the network request.
   * @return A custom [V] success response model.
   */
  public fun map(apiSuccessResponse: ApiResponse.Success): V
}