loreddev/x
1
0
Fork 0
Code Issues Pull Requests Activity

docs(blogo,fs): documentation about FromIOFS and FromIOFile

Browse Source
This commit is contained in:
Guz
2025-01-22 20:02:06 -03:00
parent 9a13d2226a
commit 52d74936a3
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
blogo/fs/iofs.go
View File

@@ -19,6 +19,8 @@ import (
iofs "io/fs" iofs "io/fs"
) )
// Wraps the provided [iofs.FS] file system so it can be used as a file system for blogo.
// [Metadata] from this [FS] will be empty, and by default, mutable.
func FromIOFS(fsys iofs.FS, immutable ...bool) FS { func FromIOFS(fsys iofs.FS, immutable ...bool) FS {
if fsys == nil { if fsys == nil {
return nil return nil
@@ -56,6 +58,8 @@ func (f *wrapperFS) Open(name string) (File, error) {
return FromIOFile(file, f.immutable), nil return FromIOFile(file, f.immutable), nil
} }
// Wraps the provided [iofs.File] so it can be used as a file system for blogo.
// [Metadata] from this [File] will be empty, and by default, mutable.
func FromIOFile(file iofs.File, immutable ...bool) File { func FromIOFile(file iofs.File, immutable ...bool) File {
m := MetadataMap(map[string]any{}) m := MetadataMap(map[string]any{})
if len(immutable) > 0 && immutable[0] { if len(immutable) > 0 && immutable[0] {