github.com/BarDweller/libpak@v0.0.0-20230630201634-8dd5cfc15ec9/sherpa/config.go (about)

     1  /*
     2   * Copyright 2018-2020 the original author or authors.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *      https://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package sherpa
    18  
    19  import (
    20  	"io"
    21  
    22  	"github.com/buildpacks/libcnb"
    23  )
    24  
    25  // Config is an object that contains configurable properties for execution.
    26  type Config struct {
    27  	arguments   []string
    28  	execdWriter io.Writer
    29  	exitHandler libcnb.ExitHandler
    30  }
    31  
    32  // Option is a function for configuring a Config instance.
    33  type Option func(config Config) Config
    34  
    35  // WithArguments creates an Option that sets a collection of arguments.
    36  func WithArguments(arguments []string) Option {
    37  	return func(config Config) Config {
    38  		config.arguments = arguments
    39  		return config
    40  	}
    41  }
    42  
    43  // WithExecdWriter creates an Option that sets an exec.d Writer implementation.
    44  func WithExecdWriter(writer io.Writer) Option {
    45  	return func(config Config) Config {
    46  		config.execdWriter = writer
    47  		return config
    48  	}
    49  }
    50  
    51  // WithExitHandler creates an Option that sets an ExitHandler implementation.
    52  func WithExitHandler(exitHandler libcnb.ExitHandler) Option {
    53  	return func(config Config) Config {
    54  		config.exitHandler = exitHandler
    55  		return config
    56  	}
    57  }