LeadKit/Sources/Protocols/DataLoading/GeneralDataLoading/GeneralDataLoadingHandler.s...

42 lines
1.7 KiB
Swift

//
// Copyright (c) 2018 Touch Instinct
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the Software), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
/// Protocol that defines methods for common data loading states handling.
public protocol GeneralDataLoadingHandler {
associatedtype ResultType
/// Called when data loading has started.
func onLoadingState()
/// Called when data loading has finished with non-empty result.
func onResultsState(result: ResultType)
/// Called when data loading did finished with empty result.
func onEmptyState()
/// Gets called when error is occured during data loading.
///
/// - Parameter error: An error that occurred while loading data.
func onErrorState(error: Error)
}