README
Documentation
¶
Index ¶
- Variables
- func Copy(srcpath, dstpath string) error
- func Create(name string, opt ...Option) (*os.File, error)
- func CreateTemp(dir string, pattern string, opt ...Option) (*os.File, error)
- func Exists(name string) (bool, error)
- func IsDir(name string) (bool, error)
- func IsEmptyDir(name string) (bool, error)
- func Mkdir(name string, opt ...Option) error
- func MkdirAll(path string, opt ...Option) error
- func MkdirTemp(dir string, pattern string, opt ...Option) (string, error)
- func Move(oldpath, newpath string) error
- func MustExists(name string) bool
- func MustIsDir(name string) bool
- func MustIsEmptyDir(name string) bool
- func MustReadDir(name string) []fs.DirEntry
- func MustReadDirnames(name string) []string
- func MustReaddir(name string) []fs.FileInfo
- func Open(name string, opt ...Option) (*os.File, error)
- func OpenFile(name string, flag int, opt ...Option) (*os.File, error)
- func ReadDir(name string) ([]fs.DirEntry, error)
- func ReadDirnames(name string) ([]string, error)
- func ReadFile(name string) ([]byte, error)
- func ReadLine(name string) iter.Seq[string]
- func Readdir(name string) ([]fs.FileInfo, error)
- func Remove(name string) error
- func RemoveAll(path string) error
- func Rename(oldpath, newpath string) error
- func SetDefaultDirFileMode(perm fs.FileMode)
- func SetDefaultFileMode(perm fs.FileMode)
- func Walk(name string) iter.Seq2[string, fs.FileInfo]
- func WriteFile(name string, data []byte, opt ...Option) error
- type FileReader
- type FileWriter
- type Option
Constants ¶
This section is empty.
Variables ¶
var DefaultDirPerm fs.FileMode = 0755 // ディレクトリパーミッションのデフォルト値（0755）
var DefaultFilePerm fs.FileMode = 0644 // ファイルパーミッションのデフォルト値（0644）
Functions ¶
func Copy ¶
Copy は、指定された srcpath から dstpath へファイルまたはディレクトリをコピーします。 ファイルの場合は、そのまま内容をコピーし、 ディレクトリの場合は中のファイル・ディレクトリを再帰的にコピーします。
func CreateTemp ¶
CreateTemp は指定されたディレクトリに一時ファイルを作成します。 ディレクトリが存在しない場合は作成し、指定されたパターンに基づいて一時ファイルを作成します。 オプションでファイルに関する設定を指定できます。
func MkdirTemp ¶
MkdirTemp は指定されたディレクトリに一時ディレクトリを作成します。 作成したディレクトリに指定されたパーミッションを設定します。 オプションでファイルに関する設定を指定できます。
func Move ¶
Move はファイルまたはディレクトリを oldpath から newpath に移動します。 まず os.Rename を試みますが、失敗した場合は Copy でコピーを行い、 その後、元のファイルを削除します。
func MustExists ¶
MustExists は指定されたファイルまたはディレクトリが存在するかを確認します。 存在する場合は true を返し、存在しない場合は false を返します。 エラーが発生した場合も false を返します。
func MustIsEmptyDir ¶
MustIsEmptyDir は指定されたディレクトリが空かどうかを確認します。 エラーが発生した場合、false を返します。
func MustReadDir ¶
MustReadDir は指定されたディレクトリ内のエントリ（ディレクトリやファイル）の情報を一覧で取得します。 エラーが発生した場合、空のスライスを返します。
func MustReadDirnames ¶
MustReadDirnames は指定されたディレクトリ内のファイル名のみを一覧で取得します。 エラーが発生した場合、空のスライスを返します。
func MustReaddir ¶
MustReaddir は指定されたディレクトリ内のファイル情報を一覧で取得します。 エラーが発生した場合、空のスライスを返します。
func OpenFile ¶
OpenFile は指定されたファイルを指定されたフラグで開きます。 必要に応じてディレクトリを作成し、ファイルを開き直します。 オプションでファイルに関する設定を指定できます。
func ReadDirnames ¶
ReadDirnames は指定されたディレクトリ内のファイル名のみを一覧で取得します。
func ReadLine ¶ added in v0.1.0
ReadLine は指定されたファイルを1行ずつ読み込むイテレータを返します。 例:
for line := range ReadLine("example.txt") {
fmt.Println(line)
}
func Rename ¶
Rename は、指定された oldpath のファイルまたはディレクトリの名前を newpath に変更します。 移動先のパスが異なるデバイス上にある場合など、一部の環境では失敗することがあります。
func SetDefaultDirFileMode ¶
SetDefaultDirFileMode は、デフォルトのディレクトリパーミッションを設定します。 この関数を呼び出すことで、ディレクトリの作成時に使用されるデフォルトのパーミッションが変更されます。
func SetDefaultFileMode ¶
SetDefaultFileMode は、デフォルトのファイルパーミッションを設定します。 この関数を呼び出すことで、ファイルの作成時に使用されるデフォルトのパーミッションが変更されます。
Types ¶
type FileReader ¶
type FileReader struct {
// contains filtered or unexported fields
}
FileReader はファイルの読み取り操作をラップする構造体です。 Read、ReadAt、Close メソッドを提供します。
func OpenFileReader ¶
func OpenFileReader(name string) (*FileReader, error)
OpenFileReader は、指定されたファイルを読み込み専用で開き、 FileReader インスタンスを返します。
func (*FileReader) Close ¶
func (r *FileReader) Close() error
Close は、ファイルを閉じます。 ファイルを正常に閉じた場合は nil を返し、エラーが発生した場合はそのエラーを返します。
type FileWriter ¶
type FileWriter struct {
// contains filtered or unexported fields
}
FileWriter はファイルへの書き込みを管理する構造体です。
func OpenFileWriter ¶
func OpenFileWriter(name string, opt ...Option) (*FileWriter, error)
OpenFileWriterは、指定されたファイル名に対して安全に書き込むためのWriterを作成します。 書き込み中は一時ファイルにデータが書き込まれ、 書き込みが完了した後に指定された名前のファイルにデータが反映されます。 オプションでファイルに関する設定を指定できます。
func (*FileWriter) Close ¶
func (w *FileWriter) Close() error
Close はファイルをクローズし、必要に応じてファイルの同期、名前の変更を行います。 書き込みエラーが発生した場合はそのエラーを返し、 最後にエラーが発生した場合は一時ファイルを削除します。
type Option ¶
type Option func(options) options
Option は、設定を変更する関数の型です。
func WithDirPerm ¶
WithDirPerm は、ディレクトリのパーミッションを設定するオプションを返します。 このオプションは、ディレクトリの作成時に使用されるパーミッションを指定します。
func WithFilePerm ¶
WithFilePerm は、ファイルのパーミッションを設定するオプションを返します。 このオプションは、ファイルの作成時に使用されるパーミッションを指定します。
Source Files