github.com/maruel/nin@v0.0.0-20220112143044-f35891e3ce7e/status.go (about)

     1  // Copyright 2016 Google Inc. All Rights Reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package nin
    16  
    17  // TODO(maruel): Create a Status (or LinePrinter?) for test cases that
    18  // redirect to testing.T.Log().
    19  
    20  // Status is the interface that tracks the status of a build:
    21  // completion fraction, printing updates.
    22  type Status interface {
    23  	PlanHasTotalEdges(total int)
    24  	BuildEdgeStarted(edge *Edge, startTimeMillis int32)
    25  	BuildEdgeFinished(edge *Edge, endTimeMillis int32, success bool, output string)
    26  	BuildLoadDyndeps()
    27  	BuildStarted()
    28  	BuildFinished()
    29  
    30  	Info(msg string, i ...interface{})
    31  	Warning(msg string, i ...interface{})
    32  	Error(msg string, i ...interface{})
    33  }