Module: Tilia::VObject::Splitter::SplitterInterface

Included in:

ICalendar, VCard

Defined in:

lib/tilia/v_object/splitter/splitter_interface.rb

Overview

VObject splitter.

The splitter is responsible for reading a large vCard or iCalendar object, and splitting it into multiple objects.

This is for example for Card and CalDAV, which require every event and vcard to exist in their own objects, instead of one large one.

Instance Method Summary

• #initialize(_input) ⇒ Object

  Constructor.

• #next ⇒ Sabre\VObject\Component^?

  Every time self.next is called, a new object will be parsed, until we hit the end of the stream.

Instance Method Details

#initialize(_input) ⇒ Object

Constructor.

The splitter should receive an readable file stream as it’s input.

Parameters:

• input (resource)

# File 'lib/tilia/v_object/splitter/splitter_interface.rb', line 17

def initialize(_input)
end

#next ⇒ Sabre\VObject\Component^?

Every time self.next is called, a new object will be parsed, until we hit the end of the stream.

When the end is reached, null will be returned.

Returns:

• (Sabre\VObject\Component, nil)

# File 'lib/tilia/v_object/splitter/splitter_interface.rb', line 26

def next
end