fp-go/v2/either/types.go

// Copyright (c) 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 either

import (
	"github.com/IBM/fp-go/v2/endomorphism"
	"github.com/IBM/fp-go/v2/lazy"
	"github.com/IBM/fp-go/v2/monoid"
	"github.com/IBM/fp-go/v2/optics/lens"
	"github.com/IBM/fp-go/v2/option"
	"github.com/IBM/fp-go/v2/reader"
)

// Option is a type alias for option.Option, provided for convenience
// when working with Either and Option together.
type (
	Option[A any]       = option.Option[A]
	Lens[S, T any]      = lens.Lens[S, T]
	Endomorphism[T any] = endomorphism.Endomorphism[T]
	Lazy[T any]         = lazy.Lazy[T]

	Kleisli[E, A, B any]  = reader.Reader[A, Either[E, B]]
	Operator[E, A, B any] = Kleisli[E, Either[E, A], B]
	Monoid[E, A any]      = monoid.Monoid[Either[E, A]]
)