walker

Documentation

Overview

Package walker provides utilities for iterating through the message and all its parts.

Index

• type Parts
  • func (w Parts) Walk(msg message.Generic) error
  • func (w Parts) WalkMultipart(msg message.Generic) error
  • func (w Parts) WalkOpaque(msg message.Generic) error

Types

type Parts

type Parts func(depth, i int, part message.Part) error

Parts is a function that can be processed for each part of a message.

Deprecated: Use walk.Processor with walk.AndProcess() or walk.Transformer with walk.AndTransform() instead.

func (Parts) Walk

func (w Parts) Walk(msg message.Generic) error

Walk performs a depth first search for all the parts of a message starting with the message itself. It calls the Parts for each part of the message. If the Parts function returns an error, then processing stops immediately and the error is returned.

Deprecated: Use walk.AndProcess() instead.

func (Parts) WalkMultipart

func (w Parts) WalkMultipart(msg message.Generic) error

WalkMultipart will call the Parts function for each Multiline message using a depth first traversal. It will terminate the walk immediately if the Parts function returns an error and will return that error.

Deprecated: Use walk.AndProcessMultipart() instead.

func (Parts) WalkOpaque

func (w Parts) WalkOpaque(msg message.Generic) error

WalkOpaque will call the Parts function for each Opaque message using a depth first traversal. It will terminate the walk immediately if the Parts function returns an error and will return the error.

Deprecated: Use walk.AndProcessOpaque() instead.