Documentation ¶
Index ¶
- Variables
- type Env
- type World
- func (world *World) BriefRoot() (briefroot string, relativecwd string, err error)
- func (world *World) BriefRoot0() (string, error)
- func (world *World) Getwd() (string, error)
- func (world *World) InterpretAddrish(addrish string) (*netmail.Address, error)
- func (world *World) InterpretMsgidish(msgidish string) (msgs.MessageId, error)
- func (world *World) LocalTimezoneOrTimeDotLocal() *time.Location
- func (world *World) Now() time.Time
- func (world *World) Sack() (sacks.Sack, error)
- func (world *World) Write(p []byte) (int, error)
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNoBriefRoot errNoBriefRoot
ErrNoBriefRoot indicates that there has been no error with the filesystem API but in the Brief semantics no briefroot has been found.
Functions ¶
This section is empty.
Types ¶
type World ¶
type World struct { // of "path" (not "path/filepath") style // relative Cwd string // "PWD" key is ignored Env vfs.FS // may be nil PasswordSource vault.PasswordSource // may be nil Stdout io.Writer StdoutUnderstandsANSI bool Stderr io.Writer // may be nil NowFunc func() time.Time // may be nil // [2024-02-13, jfrech] TODO s/LocalTimezone/LocalTimezoneFunc/ LocalTimezone *time.Location // may be nil InterpretAddrishFunc func(addrish string) (*netmail.Address, error) InterpretMsgidishFunc func(msgidish string) (msgs.MessageId, error) }
func OSEntire ¶
OSEntire returns the view of the entire operating system, with its filesystem unrestrictedly rooted at "/". See (*World).EnterBriefRoot to restrict a *World's view.
Used primarily internally and by "brief init".
func (*World) BriefRoot ¶
func (*World) BriefRoot0 ¶
on nil error, the returned string may be a briefroot or may need traversal furhter back which might result in a briefroot
BriefRoot0 should only be called by "brief init" and BriefRoot
func (*World) InterpretAddrish ¶
func (*World) InterpretMsgidish ¶
func (*World) LocalTimezoneOrTimeDotLocal ¶
TODO **UGLY** name
func (*World) Sack ¶
TODO maybe have a (*World).AlternateSack when one does not want the vfs-based fssack?
Click to show internal directories.
Click to hide internal directories.