github.com/nutsdb/nutsdb@v1.0.4/rwmanager.go (about)

     1  // Copyright 2019 The nutsdb Author. All rights reserved.
     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 nutsdb
    16  
    17  // RWMode represents the read and write mode.
    18  type RWMode int
    19  
    20  const (
    21  	// FileIO represents the read and write mode using standard I/O.
    22  	FileIO RWMode = iota
    23  
    24  	// MMap represents the read and write mode using mmap.
    25  	MMap
    26  )
    27  
    28  // RWManager represents an interface to a RWManager.
    29  type RWManager interface {
    30  	WriteAt(b []byte, off int64) (n int, err error)
    31  	ReadAt(b []byte, off int64) (n int, err error)
    32  	Sync() (err error)
    33  	Release() (err error)
    34  	Size() int64
    35  	Close() (err error)
    36  }