peerutil

Documentation

Overview

Package peerutil provides utilities around peer ID values.

Index

• type Policy
  • func NewPolicy(value bool, except ...peer.ID) Policy
  • func NewPolicyStrings(value bool, except []string) (Policy, error)
  • func (p *Policy) Any(value bool) bool
  • func (p *Policy) Default() bool
  • func (p *Policy) Eval(peerID peer.ID) bool
  • func (p *Policy) Except() []peer.ID
  • func (p *Policy) ExceptStrings() []string
  • func (p *Policy) SetPeer(peerID peer.ID, value bool) bool

Types

type Policy

type Policy struct {
	// contains filtered or unexported fields
}

Policy is a boolean value with a set of zero or more peer ID values. Evaluating a peer ID returns the boolean value, or its opposite if the peer ID is in the set of IDs.

This serves a basis for simple policies where the boolean value applies to all peers except those in the set of peer IDs.

func NewPolicy

func NewPolicy(value bool, except ...peer.ID) Policy

New creates a new Policy.

The Policy evaluates to the given boolean value for all peers, except those listed in the except list.

func NewPolicyStrings

func NewPolicyStrings(value bool, except []string) (Policy, error)

func (*Policy) Any

func (p *Policy) Any(value bool) bool

Any returns true if any it is possible for a true value to be returned.

func (*Policy) Default

func (p *Policy) Default() bool

Default returns the default value.

func (*Policy) Eval

func (p *Policy) Eval(peerID peer.ID) bool

Eval returns the boolean value for the specified peer.

func (*Policy) Except

func (p *Policy) Except() []peer.ID

Except returns the except list as a slice of peer.ID.

func (*Policy) ExceptStrings

func (p *Policy) ExceptStrings() []string

ExceptStrings returns the except list as a slice of peer.ID strings.

func (*Policy) SetPeer

func (p *Policy) SetPeer(peerID peer.ID, value bool) bool

SetPeer ensures that the specified peer evaluates to the specified value, altering the except set if needed. Returns true if the except set was updated.