go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/cipkg/base/actions/fs.go (about)

     1  // Copyright 2023 The LUCI Authors.
     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 actions
    16  
    17  import (
    18  	"io/fs"
    19  )
    20  
    21  // ReadLinkFS is the interface implemented by a file system that supports
    22  // symbolic links.
    23  // TODO(fancl): Replace it with https://github.com/golang/go/issues/49580
    24  type ReadLinkFS interface {
    25  	fs.FS
    26  
    27  	// ReadLink returns the destination of the named symbolic link.
    28  	// Link destinations will always be slash-separated paths.
    29  	// NOTE: Although in the standard library the link destination is guaranteed
    30  	// to be a path inside FS. We may return host destination for our use cases.
    31  	ReadLink(name string) (string, error)
    32  }