Class: Trivet::TraverseControl

Inherits:

Object

• Object
• Trivet::TraverseControl

Defined in:

lib/trivet.rb

Overview

Objects of this class control the Trivet::Node#traverse method. You generally will not need to instantiate this object yourself. See Trivet::Node#traverse for details.

Instance Attribute Summary

• #pruned ⇒ Object

  Returns true if the traversal is being pruned.

• #stopped ⇒ Object readonly

  Returns true if the traversal has been stopped.

Instance Method Summary

• #initialize ⇒ TraverseControl constructor

  ————————————————————————— initialize.

• #prune ⇒ Object

  Prunes the traversal so that the process does not recurse into children.

• #stop ⇒ Object

  Stops the traversal completely.

Constructor Details

#initialize ⇒ TraverseControl

---

initialize

# File 'lib/trivet.rb', line 1578

def initialize
	@pruned = false
	@stopped = false
end

Instance Attribute Details

#pruned ⇒ Object

Returns true if the traversal is being pruned.

# File 'lib/trivet.rb', line 1592

def pruned
  @pruned
end

#stopped ⇒ Object (readonly)

Returns true if the traversal has been stopped.

# File 'lib/trivet.rb', line 1595

def stopped
  @stopped
end

Instance Method Details

#prune ⇒ Object

Prunes the traversal so that the process does not recurse into children.

# File 'lib/trivet.rb', line 1607

def prune
	@pruned = true
end

#stop ⇒ Object

Stops the traversal completely.

# File 'lib/trivet.rb', line 1612

def stop
	@stopped = true
end