policy

Documentation

Index

• type Policy
  • func New(cfg config.Policy) (*Policy, error)
  • func (p *Policy) Allow(peerIDs ...peer.ID) bool
  • func (p *Policy) Allowed(peerID peer.ID) bool
  • func (p *Policy) Block(peerIDs ...peer.ID) bool
  • func (p *Policy) Copy(other *Policy)
  • func (p *Policy) NoneAllowed() bool
  • func (p *Policy) PublishAllowed(publisherID, providerID peer.ID) bool
  • func (p *Policy) ToConfig() config.Policy

Types

type Policy

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

func New

func New(cfg config.Policy) (*Policy, error)

func (*Policy) Allow

func (p *Policy) Allow(peerIDs ...peer.ID) bool

Allow alters the policy to allow the specified peer. Returns true if the policy needed to be updated.

func (*Policy) Allowed

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

Allowed returns true if the policy allows the peer to index content.

func (*Policy) Block

func (p *Policy) Block(peerIDs ...peer.ID) bool

Block alters the policy to not allow the specified peer. Returns true if the policy needed to be updated.

func (*Policy) Copy

func (p *Policy) Copy(other *Policy)

Copy copies another policy.

func (*Policy) NoneAllowed

func (p *Policy) NoneAllowed() bool

Return true if no peers are allowed.

func (*Policy) PublishAllowed

func (p *Policy) PublishAllowed(publisherID, providerID peer.ID) bool

PublishAllowed returns true if policy allows the publisher to publish advertisements for the identified provider, and the provider is allowed.

func (*Policy) ToConfig

func (p *Policy) ToConfig() config.Policy

ToConfig converts a Policy into a config.Policy.