1
0
mirror of https://github.com/IBM/fp-go.git synced 2025-12-03 22:49:17 +02:00
Files
fp-go/v2/reader/generic/curry.go
Dr. Carsten Leue 107618cef8 fix: better doc
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2025-11-06 09:24:09 +01:00

158 lines
5.5 KiB
Go

// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// 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 generic
import (
F "github.com/IBM/fp-go/v2/function"
)
// These functions curry a Go function with the context as the first parameter into a generic Reader
// with the context as the last parameter, which is equivalent to a function returning a Reader
// of that context.
//
// This follows the Go convention (https://pkg.go.dev/context) of putting the context as the
// first parameter, while Reader monad convention has the context as the last parameter.
//
// The generic versions work with custom reader types that match the pattern ~func(R) A.
// Curry0 converts a function that takes a context and returns a value into a generic Reader.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - A: The result type
func Curry0[GA ~func(R) A, R, A any](f func(R) A) GA {
return MakeReader[GA](f)
}
// Curry1 converts a function with context as first parameter into a curried function
// returning a generic Reader. The context parameter is moved to the end (Reader position).
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - T1: The first parameter type
// - A: The result type
func Curry1[GA ~func(R) A, R, T1, A any](f func(R, T1) A) func(T1) GA {
return F.Curry1(From1[GA](f))
}
// Curry2 converts a function with context as first parameter and 2 other parameters
// into a curried function returning a generic Reader.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - T1, T2: The parameter types
// - A: The result type
func Curry2[GA ~func(R) A, R, T1, T2, A any](f func(R, T1, T2) A) func(T1) func(T2) GA {
return F.Curry2(From2[GA](f))
}
// Curry3 converts a function with context as first parameter and 3 other parameters
// into a curried function returning a generic Reader.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - T1, T2, T3: The parameter types
// - A: The result type
func Curry3[GA ~func(R) A, R, T1, T2, T3, A any](f func(R, T1, T2, T3) A) func(T1) func(T2) func(T3) GA {
return F.Curry3(From3[GA](f))
}
// Curry4 converts a function with context as first parameter and 4 other parameters
// into a curried function returning a generic Reader.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - T1, T2, T3, T4: The parameter types
// - A: The result type
func Curry4[GA ~func(R) A, R, T1, T2, T3, T4, A any](f func(R, T1, T2, T3, T4) A) func(T1) func(T2) func(T3) func(T4) GA {
return F.Curry4(From4[GA](f))
}
// Uncurry0 converts a generic Reader back into a regular function with context as first parameter.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - A: The result type
func Uncurry0[GA ~func(R) A, R, A any](f GA) func(R) A {
return f
}
// Uncurry1 converts a curried function returning a generic Reader back into a regular function
// with context as first parameter.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - T1: The first parameter type
// - A: The result type
func Uncurry1[GA ~func(R) A, R, T1, A any](f func(T1) GA) func(R, T1) A {
uc := F.Uncurry1(f)
return func(r R, t1 T1) A {
return uc(t1)(r)
}
}
// Uncurry2 converts a curried function with 2 parameters returning a generic Reader back into
// a regular function with context as first parameter.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - T1, T2: The parameter types
// - A: The result type
func Uncurry2[GA ~func(R) A, R, T1, T2, A any](f func(T1) func(T2) GA) func(R, T1, T2) A {
uc := F.Uncurry2(f)
return func(r R, t1 T1, t2 T2) A {
return uc(t1, t2)(r)
}
}
// Uncurry3 converts a curried function with 3 parameters returning a generic Reader back into
// a regular function with context as first parameter.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - T1, T2, T3: The parameter types
// - A: The result type
func Uncurry3[GA ~func(R) A, R, T1, T2, T3, A any](f func(T1) func(T2) func(T3) GA) func(R, T1, T2, T3) A {
uc := F.Uncurry3(f)
return func(r R, t1 T1, t2 T2, t3 T3) A {
return uc(t1, t2, t3)(r)
}
}
// Uncurry4 converts a curried function with 4 parameters returning a generic Reader back into
// a regular function with context as first parameter.
//
// Type Parameters:
// - GA: The generic Reader type (~func(R) A)
// - R: The environment/context type
// - T1, T2, T3, T4: The parameter types
// - A: The result type
func Uncurry4[GA ~func(R) A, R, T1, T2, T3, T4, A any](f func(T1) func(T2) func(T3) func(T4) GA) func(R, T1, T2, T3, T4) A {
uc := F.Uncurry4(f)
return func(r R, t1 T1, t2 T2, t3 T3, t4 T4) A {
return uc(t1, t2, t3, t4)(r)
}
}