group.go

// Copyright 2023-2024 Oliver Eikemeier. 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.
//
// SPDX-License-Identifier: Apache-2.0

package async

// A Group is a collection of asynchronous operations working on the same task.
type Group interface {
	Go(fn func() error)
}

// DoAsync schedules an asynchronous operation on the [Group] and returns a Future
// to retrieve the eventual result.
func DoAsync[R any](g Group, fn func() (R, error)) *Future[R] {
	var p Promise[R]
	g.Go(func() error {
		p.Do(fn)

		return p.err
	})

	return p.Future()
}