github.com/codysnider/go-ethereum@v1.10.18-0.20220420071915-14f4ae99222a/les/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  	FastSync                  // Quickly download the headers, full sync only at the chain
    28  	SnapSync                  // Download the chain and the state via compact snapshots
    29  	LightSync                 // Download only the headers and terminate afterwards
    30  )
    31  
    32  func (mode SyncMode) IsValid() bool {
    33  	return mode >= FullSync && mode <= LightSync
    34  }
    35  
    36  // String implements the stringer interface.
    37  func (mode SyncMode) String() string {
    38  	switch mode {
    39  	case FullSync:
    40  		return "full"
    41  	case FastSync:
    42  		return "fast"
    43  	case SnapSync:
    44  		return "snap"
    45  	case LightSync:
    46  		return "light"
    47  	default:
    48  		return "unknown"
    49  	}
    50  }
    51  
    52  func (mode SyncMode) MarshalText() ([]byte, error) {
    53  	switch mode {
    54  	case FullSync:
    55  		return []byte("full"), nil
    56  	case FastSync:
    57  		return []byte("fast"), nil
    58  	case SnapSync:
    59  		return []byte("snap"), nil
    60  	case LightSync:
    61  		return []byte("light"), nil
    62  	default:
    63  		return nil, fmt.Errorf("unknown sync mode %d", mode)
    64  	}
    65  }
    66  
    67  func (mode *SyncMode) UnmarshalText(text []byte) error {
    68  	switch string(text) {
    69  	case "full":
    70  		*mode = FullSync
    71  	case "fast":
    72  		*mode = FastSync
    73  	case "snap":
    74  		*mode = SnapSync
    75  	case "light":
    76  		*mode = LightSync
    77  	default:
    78  		return fmt.Errorf(`unknown sync mode %q, want "full", "fast" or "light"`, text)
    79  	}
    80  	return nil
    81  }