Class: Wayfarer::Routing::PathConsumer::ConsumptionState Private

Inherits:

Struct

• Object
• Struct
• Wayfarer::Routing::PathConsumer::ConsumptionState

Defined in:

lib/wayfarer/routing/path_consumer.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

The result of consuming part of a path.

Instance Attribute Summary

• #offset ⇒ Integer^?

  Index into the path string.

• #params ⇒ Hash

  Collected path parameters.

• #valid? ⇒ Boolean

  Whether the current state is valid.

Instance Attribute Details

#offset ⇒ Integer^?

Returns index into the path string.

Returns:

• (Integer, nil) —

  index into the path string

# File 'lib/wayfarer/routing/path_consumer.rb', line 17

ConsumptionState = Struct.new(:offset, :params, :valid?, keyword_init: true)

#params ⇒ Hash

Returns collected path parameters.

Returns:

• (Hash) —

  collected path parameters

# File 'lib/wayfarer/routing/path_consumer.rb', line 17

ConsumptionState = Struct.new(:offset, :params, :valid?, keyword_init: true)

#valid? ⇒ Boolean

Returns whether the current state is valid.

Returns:

• (Boolean) —

  whether the current state is valid

# File 'lib/wayfarer/routing/path_consumer.rb', line 17

ConsumptionState = Struct.new(:offset, :params, :valid?, keyword_init: true)