<!DOCTYPE html>
<html lang="en">
	<head>
		<title>bufat - options.go</title>
		<link type="text/css" rel="stylesheet" href="/style/src.css">
	</head>
	<body>
		<h1><a href="/bufat">bufat</a> - options.go</h1>
		<pre>
<span class="hidden"><a id="L1" href="#L1">     1</a>  </span><span>package bufat</span>
<span class="hidden"><a id="L2" href="#L2">     2</a>  </span>
<span class="hidden"><a id="L3" href="#L3">     3</a>  </span><span class="text">// Options is a type used to specify caching options to the Buffer function.</span>
<span class="hidden"><a id="L4" href="#L4">     4</a>  </span><span>type Option func(*opts)</span>
<span class="hidden"><a id="L5" href="#L5">     5</a>  </span>
<span class="hidden"><a id="L6" href="#L6">     6</a>  </span><span>type opts struct {</span>
<span class="hidden"><a id="L7" href="#L7">     7</a>  </span><span>	mru       bool</span>
<span class="hidden"><a id="L8" href="#L8">     8</a>  </span><span>	chunks    uint64</span>
<span class="hidden"><a id="L9" href="#L9">     9</a>  </span><span>	chunkSize int64</span>
<span class="hidden"><a id="L10" href="#L10">    10</a>  </span><span>	length    int64</span>
<span class="hidden"><a id="L11" href="#L11">    11</a>  </span><span>	offset    int64</span>
<span class="hidden"><a id="L12" href="#L12">    12</a>  </span><span>}</span>
<span class="hidden"><a id="L13" href="#L13">    13</a>  </span>
<span class="hidden"><a id="L14" href="#L14">    14</a>  </span><span class="text">// ChunkSize determines the size of each cached block.</span>
<span class="hidden"><a id="L15" href="#L15">    15</a>  </span><span class="text">//</span>
<span class="hidden"><a id="L16" href="#L16">    16</a>  </span><span class="text">// If unset, or set to a value less-than or equal to 0, the value 4,096 will be</span>
<span class="hidden"><a id="L17" href="#L17">    17</a>  </span><span class="text">// used.</span>
<span class="hidden"><a id="L18" href="#L18">    18</a>  </span><span>func ChunkSize(size int64) Option {</span>
<span class="hidden"><a id="L19" href="#L19">    19</a>  </span><span>	return func(o *opts) {</span>
<span class="hidden"><a id="L20" href="#L20">    20</a>  </span><span>		o.chunkSize = size</span>
<span class="hidden"><a id="L21" href="#L21">    21</a>  </span><span>	}</span>
<span class="hidden"><a id="L22" href="#L22">    22</a>  </span><span>}</span>
<span class="hidden"><a id="L23" href="#L23">    23</a>  </span>
<span class="hidden"><a id="L24" href="#L24">    24</a>  </span><span class="text">// MaxChunks sets the maximum number of chunks that will store i nthe cache</span>
<span class="hidden"><a id="L25" href="#L25">    25</a>  </span><span class="text">// before chunks start getting evicted.</span>
<span class="hidden"><a id="L26" href="#L26">    26</a>  </span>
<span class="hidden"><a id="L27" href="#L27">    27</a>  </span><span class="text">// If unset, or set to zero, the value will be 1,024.</span>
<span class="hidden"><a id="L28" href="#L28">    28</a>  </span><span>func MaxChunks(chunks uint64) Option {</span>
<span class="hidden"><a id="L29" href="#L29">    29</a>  </span><span>	return func(o *opts) {</span>
<span class="hidden"><a id="L30" href="#L30">    30</a>  </span><span>		o.chunks = chunks</span>
<span class="hidden"><a id="L31" href="#L31">    31</a>  </span><span>	}</span>
<span class="hidden"><a id="L32" href="#L32">    32</a>  </span><span>}</span>
<span class="hidden"><a id="L33" href="#L33">    33</a>  </span>
<span class="hidden"><a id="L34" href="#L34">    34</a>  </span><span class="text">// MRU sets the cache to evict the most recently used blocks first.</span>
<span class="hidden"><a id="L35" href="#L35">    35</a>  </span><span>func MRU(o *opts) {</span>
<span class="hidden"><a id="L36" href="#L36">    36</a>  </span><span>	o.mru = true</span>
<span class="hidden"><a id="L37" href="#L37">    37</a>  </span><span>}</span>
<span class="hidden"><a id="L38" href="#L38">    38</a>  </span>
<span class="hidden"><a id="L39" href="#L39">    39</a>  </span><span class="text">// LRU sets the cache to evict the least recently used blocks first.</span>
<span class="hidden"><a id="L40" href="#L40">    40</a>  </span><span>func LRU(o *opts) {</span>
<span class="hidden"><a id="L41" href="#L41">    41</a>  </span><span>	o.mru = false</span>
<span class="hidden"><a id="L42" href="#L42">    42</a>  </span><span>}</span>
<span class="hidden"><a id="L43" href="#L43">    43</a>  </span>
<span class="hidden"><a id="L44" href="#L44">    44</a>  </span><span class="text">// Length is an option to specify that maximum read position of the underlying</span>
<span class="hidden"><a id="L45" href="#L45">    45</a>  </span><span class="text">// ReaderAt.</span>
<span class="hidden"><a id="L46" href="#L46">    46</a>  </span><span>func Length(l int64) Option {</span>
<span class="hidden"><a id="L47" href="#L47">    47</a>  </span><span>	return func(o *opts) {</span>
<span class="hidden"><a id="L48" href="#L48">    48</a>  </span><span>		o.length = l</span>
<span class="hidden"><a id="L49" href="#L49">    49</a>  </span><span>	}</span>
<span class="hidden"><a id="L50" href="#L50">    50</a>  </span><span>}</span>
<span class="hidden"><a id="L51" href="#L51">    51</a>  </span>
<span class="hidden"><a id="L52" href="#L52">    52</a>  </span><span class="text">// Offset sets a reader offset that will be added to the request read position.</span>
<span class="hidden"><a id="L53" href="#L53">    53</a>  </span><span>func Offset(offset int64) Option {</span>
<span class="hidden"><a id="L54" href="#L54">    54</a>  </span><span>	return func(o *opts) {</span>
<span class="hidden"><a id="L55" href="#L55">    55</a>  </span><span>		o.offset = offset</span>
<span class="hidden"><a id="L56" href="#L56">    56</a>  </span><span>	}</span>
<span class="hidden"><a id="L57" href="#L57">    57</a>  </span><span>}</span>
<span class="hidden"><a id="L58" href="#L58">    58</a>  </span></pre>
	</body>
</html>
