github.com/google/osv-scalibr@v0.4.1/extractor/filesystem/errors.go (about)

     1  // Copyright 2025 Google LLC
     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 filesystem
    16  
    17  import (
    18  	"errors"
    19  
    20  	"github.com/google/osv-scalibr/stats"
    21  )
    22  
    23  var (
    24  	// ErrExtractorMemoryLimitExceeded is returned when an extractor skips a file
    25  	// due to the extraction process exceeding a configured memory limit.
    26  	ErrExtractorMemoryLimitExceeded = errors.New("extraction failed due to extractor exceeding the configured memory limit")
    27  )
    28  
    29  // ExtractorErrorToFileExtractedResult converts an error returned by an extractor
    30  // to a FileExtractedResult for stats collection. Converting the error to a
    31  // result minimizes the memory used for reporting stats.
    32  func ExtractorErrorToFileExtractedResult(err error) stats.FileExtractedResult {
    33  	if err == nil {
    34  		return stats.FileExtractedResultSuccess
    35  	} else if errors.Is(err, ErrExtractorMemoryLimitExceeded) {
    36  		return stats.FileExtractedResultErrorMemoryLimitExceeded
    37  	}
    38  	return stats.FileExtractedResultErrorUnknown
    39  }