github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/os/file.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package xos
    22  
    23  import (
    24  	"os"
    25  
    26  	xerrors "github.com/m3db/m3/src/x/errors"
    27  )
    28  
    29  // File is the interface implemented by *os.File.
    30  type File interface {
    31  	// Write bytes to the file descriptor.
    32  	Write(p []byte) (int, error)
    33  	// Sync fsyncs the file descriptor ensuring all writes have made it to disk.
    34  	Sync() error
    35  	// Close the file descriptor.
    36  	Close() error
    37  }
    38  
    39  // WriteFileSync calls fsync() in addition to writing a file to disk.
    40  func WriteFileSync(name string, data []byte, perm os.FileMode) error {
    41  	f, err := os.OpenFile(name, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, perm) //nolint:gosec
    42  	if err != nil {
    43  		return err
    44  	}
    45  	_, err = f.Write(data)
    46  	return xerrors.FirstError(err, f.Sync(), f.Close())
    47  }