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

     1  // Copyright (c) 2020 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 io
    22  
    23  // Options are options for resettable readers and writers.
    24  type Options interface {
    25  	// ResettableReaderFn returns the reader function.
    26  	SetResettableReaderFn(value ResettableReaderFn) Options
    27  
    28  	// // ResettableReaderFn sets the reader function.
    29  	ResettableReaderFn() ResettableReaderFn
    30  
    31  	// ResettableWriterFn returns the writer function.
    32  	SetResettableWriterFn(value ResettableWriterFn) Options
    33  
    34  	// ResettableWriterFn sets the writer function.
    35  	ResettableWriterFn() ResettableWriterFn
    36  }
    37  
    38  type options struct {
    39  	resettableReaderFn ResettableReaderFn
    40  	resettableWriterFn ResettableWriterFn
    41  }
    42  
    43  // NewOptions creates a new read write options.
    44  func NewOptions() Options {
    45  	return &options{
    46  		resettableReaderFn: defaultResettableReaderFn(),
    47  		resettableWriterFn: defaultResettableWriterFn(),
    48  	}
    49  }
    50  
    51  func (opts *options) SetResettableReaderFn(value ResettableReaderFn) Options {
    52  	o := *opts
    53  	o.resettableReaderFn = value
    54  	return &o
    55  }
    56  
    57  func (opts *options) ResettableReaderFn() ResettableReaderFn {
    58  	return opts.resettableReaderFn
    59  }
    60  
    61  func (opts *options) SetResettableWriterFn(value ResettableWriterFn) Options {
    62  	o := *opts
    63  	o.resettableWriterFn = value
    64  	return &o
    65  }
    66  
    67  func (opts *options) ResettableWriterFn() ResettableWriterFn {
    68  	return opts.resettableWriterFn
    69  }