github.com/vmware/govmomi@v0.37.1/vim25/progress/sinker.go (about)

     1  /*
     2  Copyright (c) 2014 VMware, Inc. All Rights Reserved.
     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      http://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 progress
    18  
    19  // Sinker defines what is expected of a type that can act as a sink for
    20  // progress reports. The semantics are as follows. If you call Sink(), you are
    21  // responsible for closing the returned channel. Closing this channel means
    22  // that the related task is done, or resulted in error.
    23  type Sinker interface {
    24  	Sink() chan<- Report
    25  }
    26  
    27  // SinkFunc defines a function that returns a progress report channel.
    28  type SinkFunc func() chan<- Report
    29  
    30  // Sink makes the SinkFunc implement the Sinker interface.
    31  func (fn SinkFunc) Sink() chan<- Report {
    32  	return fn()
    33  }