github.com/ethereum/go-ethereum@v1.16.1/eth/ethconfig/syncmode.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 ethconfig
    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  	SnapSync                 // Download the chain and the state via compact snapshots
    28  )
    29  
    30  func (mode SyncMode) IsValid() bool {
    31  	return mode == FullSync || mode == SnapSync
    32  }
    33  
    34  // String implements the stringer interface.
    35  func (mode SyncMode) String() string {
    36  	switch mode {
    37  	case FullSync:
    38  		return "full"
    39  	case SnapSync:
    40  		return "snap"
    41  	default:
    42  		return "unknown"
    43  	}
    44  }
    45  
    46  func (mode SyncMode) MarshalText() ([]byte, error) {
    47  	switch mode {
    48  	case FullSync:
    49  		return []byte("full"), nil
    50  	case SnapSync:
    51  		return []byte("snap"), nil
    52  	default:
    53  		return nil, fmt.Errorf("unknown sync mode %d", mode)
    54  	}
    55  }
    56  
    57  func (mode *SyncMode) UnmarshalText(text []byte) error {
    58  	switch string(text) {
    59  	case "full":
    60  		*mode = FullSync
    61  	case "snap":
    62  		*mode = SnapSync
    63  	default:
    64  		return fmt.Errorf(`unknown sync mode %q, want "full" or "snap"`, text)
    65  	}
    66  	return nil
    67  }