github.com/dominant-strategies/go-quai@v0.28.2/eth/downloader/modes.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package downloader
    18  
    19  import "fmt"
    20  
    21  // SyncMode represents the synchronisation mode of the downloader.
    22  // It is a uint32 as it is used with atomic operations.
    23  type SyncMode uint32
    24  
    25  const (
    26  	FullSync SyncMode = iota // Synchronise the entire blockchain history from full blocks
    27  )
    28  
    29  func (mode SyncMode) IsValid() bool {
    30  	return mode == FullSync
    31  }
    32  
    33  // String implements the stringer interface.
    34  func (mode SyncMode) String() string {
    35  	switch mode {
    36  	case FullSync:
    37  		return "full"
    38  	default:
    39  		return "unknown"
    40  	}
    41  }
    42  
    43  func (mode SyncMode) MarshalText() ([]byte, error) {
    44  	switch mode {
    45  	case FullSync:
    46  		return []byte("full"), nil
    47  	default:
    48  		return nil, fmt.Errorf("unknown sync mode %d", mode)
    49  	}
    50  }
    51  
    52  func (mode *SyncMode) UnmarshalText(text []byte) error {
    53  	switch string(text) {
    54  	case "full":
    55  		*mode = FullSync
    56  	default:
    57  		return fmt.Errorf(`unknown sync mode %q, want "full", "fast" or "light"`, text)
    58  	}
    59  	return nil
    60  }