Categorygithub.com/sourcegraph/ctxvfs
modulepackage
0.0.0-20180418081416-2b65f1b1ea81
Repository: https://github.com/sourcegraph/ctxvfs.git
Documentation: pkg.go.dev

# README

ctxvfs Build Status

Package ctxvfs defines a virtual file system interface whose methods accept a context.Context parameter. It is otherwise similar to vfs.FileSystem.

This package is experimental until further notice.

Open the code in Sourcegraph

# Functions

Map returns a new FileSystem from the provided map.
OS returns an implementation of FileSystem reading from the tree rooted at root.
No description provided by the author
ReadFile reads the file named by path from fs and returns the contents.
No description provided by the author
StripContext is an adapter for using a ctxvfs.FileSystem (whose interface methods take a context.Context parameter) as a vfs.FileSystem (whose interface methods DON'T take a context.Context parameter).
Sync creates a new file system wrapper around fs that locks a mutex during its operations.
Walk returns a new Walker rooted at root on the FileSystem fs.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Walker provides a convenient interface for iterating over the descendants of a filesystem path.

# Interfaces

The FileSystem interface specifies the methods used to access the file system.
A ReadSeekCloser can Read, Seek, and Close.

# Type aliases

No description provided by the author
A NameSpace is a file system made up of other file systems mounted at specific locations in the name space.