forgejofs

package
v0.0.0-...-a33ddeb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2025 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ErrIsDir    = erorr.Error("forgejo: is directory")
	ErrIsNotDir = erorr.Error("forgejo: is not directory")
)

Variables

This section is empty.

Functions

func DirFS

func DirFS(dir string) (fs.FS, error)

DirFS opens the named directory as a sub-file-system.

Here are some examples:

Example 1:

filesys, err := forgejofs.DirFS("codeberg.org/reiver/retejo/docs")

Example 2:

filesys, err := forgejofs.DirFS("codeberg.org/reiver/retejo")

Example 3:

filesys, err := forgejofs.DirFS("codeberg.org/reiver")

Example 4:

filesys, err := forgejofs.DirFS("codeberg.org")

func Open

func Open(name string) (fs.File, error)

Open opens the named file (or directory) for reading.

Here are some examples:

Example 1:

file, err := forgejofs.Open("codeberg.org/reiver/go-ascii/README.md")

Example 2:

file, err := forgejofs.Open("codeberg.org/reiver/go-ascii")

Example 3:

file, err := forgejofs.Open("codeberg.org/reiver")

Example 4:

file, err := forgejofs.Open("codeberg.org")

func OpenAndLog

func OpenAndLog(logger log.Logger, name string) (fs.File, error)

Types

type DirReaderAll

type DirReaderAll = fsdir.DirReaderAll

type LoggingSubFS

type LoggingSubFS interface {
	fs.SubFS
	OpenAndLog(log.Logger, string) (fs.File, error)
}
var Root LoggingSubFS = internalRoot{}

Root represents the root of the (Forgejo part of the) Internet.

Here are some examples:

Example 1:

// Open a file.
file, err := forgejofs.Root.Open("codeberg.org/reiver/go-ascii/README.md")

Example 2:

// Open a repo.
file, err := forgejofs.Root.Open("codeberg.org/reiver/go-ascii")

Example 3:

// Open user as a sub-FS (sub-file-system).
filesys, err := forgejofs.Root.Sub("codeberg.org/reiver")

Example 4:

// Open a host.
file, err := forgejofs.Root.Open("codeberg.org")

At the top-level are the Internet domain-names of (Forgejo's subset of) the Internet. Under that are the user-names. Under that arethe repo-names. And, under that are the content of the repo.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL