github.com/matrixorigin/matrixone@v1.2.0/pkg/fileservice/mutable_file_service.go (about)

     1  // Copyright 2022 Matrix Origin
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package fileservice
    16  
    17  import "context"
    18  
    19  // MutableFileService is an extension interface to FileService that allow mutation
    20  type MutableFileService interface {
    21  	FileService
    22  
    23  	// NewMutator creates a new mutator
    24  	NewMutator(ctx context.Context, filePath string) (Mutator, error)
    25  }
    26  
    27  type Mutator interface {
    28  
    29  	// Mutate mutates file contents
    30  	Mutate(ctx context.Context, entries ...IOEntry) error
    31  
    32  	// Append appends data to file
    33  	// all IOEntry.Offset is base on the end of file position
    34  	// for example, passing IOEntry{Offset: 0, Len:1, Data: []byte("a")} will append "a" to the end of file
    35  	Append(ctx context.Context, entries ...IOEntry) error
    36  
    37  	// Close closes the mutator
    38  	// Must be called after finishing mutation
    39  	Close() error
    40  }