github.com/avfs/avfs@v0.33.1-0.20240303173310-c6ba67c33eb7/vfs/basepathfs/basepathfs_types.go (about)

     1  //
     2  //  Copyright 2020 The AVFS 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  //  	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 basepathfs
    18  
    19  import (
    20  	"github.com/avfs/avfs"
    21  )
    22  
    23  // BasePathFS implements a base path file system.
    24  type BasePathFS struct {
    25  	baseFS          avfs.VFS // baseFS is the base file system.
    26  	basePath        string   // basePath is the absolute path prepended to all files of the base file system.
    27  	avfs.FeaturesFn          // FeaturesFn provides features functions to a file system or an identity manager.
    28  }
    29  
    30  // BasePathFile represents an open file descriptor.
    31  type BasePathFile struct {
    32  	baseFile avfs.File   // baseFile represents an open file descriptor from the base file system.
    33  	vfs      *BasePathFS // vfs is the base path file system of the file.
    34  }