Module: Y

Defined in:

lib/y-rb.rb,
lib/y/doc.rb,
lib/y/map.rb,
lib/y/xml.rb,
lib/y/diff.rb,
lib/y/text.rb,
lib/y/array.rb,
lib/y/version.rb,
lib/y/awareness.rb,
lib/y/transaction.rb

Defined Under Namespace

Classes: Array, Awareness, Diff, Doc, Map, Text, Transaction, XMLElement, XMLText

Constant Summary

VERSION =

"0.5.6"

Instance Method Summary

• #yxml_element_attributes ⇒ Hash
• #yxml_element_first_child(tx) ⇒ Y::XMLElement, Y::XMLText
• #yxml_element_get(tx, index) ⇒ Y::XMLElement, ...
• #yxml_element_get_attribute(tx, name) ⇒ String^?
• #yxml_element_insert_attribute(tx, name, value) ⇒ String^?
• #yxml_element_insert_text(tx, index, text) ⇒ Y::XMLText
• #yxml_element_next_sibling(tx) ⇒ Y::XMLElement, ...
• #yxml_element_observe(callback) ⇒ Integer

  The subscription ID.

• #yxml_element_parent ⇒ Y::XMLElement^?
• #yxml_element_prev_sibling(tx) ⇒ Y::XMLElement, ...
• #yxml_element_push_element_back(tx, name) ⇒ Y::XMLElement
• #yxml_element_push_element_front(tx, name) ⇒ Y::XMLElement
• #yxml_element_push_text_back(tx, text) ⇒ Y::XMLText
• #yxml_element_push_text_front(tx, text) ⇒ Y::XMLText
• #yxml_element_remove_attribute(tx, name) ⇒ void
• #yxml_element_remove_range(tx, index, length) ⇒ void
• #yxml_element_size(tx) ⇒ Integer
• #yxml_element_tag ⇒ String
• #yxml_element_to_s(tx) ⇒ String
• #yxml_element_unobserve(subscription_id) ⇒ void
• #yxml_text_attributes ⇒ Hash
• #yxml_text_format(tx, index, length, attrs) ⇒ void
• #yxml_text_get_attribute(tx, name) ⇒ String^?
• #yxml_text_insert(tx, index, str) ⇒ void
• #yxml_text_insert_attribute(tx, name, value) ⇒ void
• #yxml_text_insert_embed(tx, index, value) ⇒ void
• #yxml_text_insert_embed_with_attrs(tx, index, value, attrs) ⇒ void
• #yxml_text_insert_with_attrs(tx, index, value, attrs) ⇒ void
• #yxml_text_length(tx) ⇒ Integer
• #yxml_text_next_sibling(tx) ⇒ Y::XMLElement, ...
• #yxml_text_observe(callback) ⇒ Integer

  A subscription ID.

• #yxml_text_parent ⇒ Y::XMLElement^?
• #yxml_text_prev_sibling(tx) ⇒ Y::XMLElement, ...
• #yxml_text_push(tx, str) ⇒ void
• #yxml_text_remove_range(tx, index, length) ⇒ void
• #yxml_text_to_s(tx) ⇒ void
• #yxml_text_unobserve(subscription_id) ⇒ void

Instance Method Details

#yxml_element_attributes ⇒ Hash

Returns:

• (Hash)

# File 'lib/y/xml.rb', line 345

#yxml_element_first_child(tx) ⇒ Y::XMLElement, Y::XMLText

Parameters:

• tx (Y::Transaction)

Returns:

• (Y::XMLElement, Y::XMLText)

# File 'lib/y/xml.rb', line 349

#yxml_element_get(tx, index) ⇒ Y::XMLElement, ...

Parameters:

• tx (Y::Transaction)
• index (Integer)

Returns:

• (Y::XMLElement, Y::XMLText, nil)

# File 'lib/y/xml.rb', line 360

#yxml_element_get_attribute(tx, name) ⇒ String^?

Parameters:

• tx (Y::Transaction)
• name (String)

Returns:

• (String, nil)

# File 'lib/y/xml.rb', line 354

#yxml_element_insert_attribute(tx, name, value) ⇒ String^?

Parameters:

• tx (Y::Transaction)
• name (String)
• value (String)

Returns:

• (String, nil)

# File 'lib/y/xml.rb', line 366

#yxml_element_insert_text(tx, index, text) ⇒ Y::XMLText

Parameters:

• tx (Y::Transaction)
• index (Integer)
• text (String)

Returns:

• (Y::XMLText)

# File 'lib/y/xml.rb', line 382

#yxml_element_next_sibling(tx) ⇒ Y::XMLElement, ...

Parameters:

• tx (Y::Transaction)

Returns:

• (Y::XMLElement, XMLText, nil)

# File 'lib/y/xml.rb', line 389

#yxml_element_observe(callback) ⇒ Integer

Returns The subscription ID.

Parameters:

• callback (Proc)

Returns:

• (Integer) —

  The subscription ID

# File 'lib/y/xml.rb', line 394

#yxml_element_parent ⇒ Y::XMLElement^?

Returns:

• (Y::XMLElement, nil)

# File 'lib/y/xml.rb', line 399

#yxml_element_prev_sibling(tx) ⇒ Y::XMLElement, ...

Parameters:

• tx (Y::Transaction)

Returns:

• (Y::XMLElement, XMLText, nil)

# File 'lib/y/xml.rb', line 403

#yxml_element_push_element_back(tx, name) ⇒ Y::XMLElement

Parameters:

• tx (Y::Transaction)
• name (String)

Returns:

• (Y::XMLElement)

# File 'lib/y/xml.rb', line 408

#yxml_element_push_element_front(tx, name) ⇒ Y::XMLElement

Parameters:

• tx (Y::Transaction)
• name (String)

Returns:

• (Y::XMLElement)

# File 'lib/y/xml.rb', line 414

#yxml_element_push_text_back(tx, text) ⇒ Y::XMLText

Parameters:

• tx (Y::Transaction)
• text (string)

Returns:

• (Y::XMLText)

# File 'lib/y/xml.rb', line 420

#yxml_element_push_text_front(tx, text) ⇒ Y::XMLText

Parameters:

• tx (Y::Transaction)
• text (string)

Returns:

• (Y::XMLText)

# File 'lib/y/xml.rb', line 426

#yxml_element_remove_attribute(tx, name) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• name (String) —

  name

# File 'lib/y/xml.rb', line 432

#yxml_element_remove_range(tx, index, length) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• index (Integer)
• length (Integer)

# File 'lib/y/xml.rb', line 438

#yxml_element_size(tx) ⇒ Integer

Parameters:

• tx (Y::Transaction)

Returns:

• (Integer)

# File 'lib/y/xml.rb', line 446

#yxml_element_tag ⇒ String

Returns:

• (String)

# File 'lib/y/xml.rb', line 451

#yxml_element_to_s(tx) ⇒ String

Parameters:

• tx (Y::Transaction)

Returns:

• (String)

# File 'lib/y/xml.rb', line 455

#yxml_element_unobserve(subscription_id) ⇒ void

This method returns an undefined value.

Parameters:

• subscription_id (Integer)

# File 'lib/y/xml.rb', line 460

#yxml_text_attributes ⇒ Hash

Returns:

• (Hash)

# File 'lib/y/xml.rb', line 790

#yxml_text_format(tx, index, length, attrs) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• index (Integer)
• length (Integer)
• attrs (Hash)

# File 'lib/y/xml.rb', line 794

#yxml_text_get_attribute(tx, name) ⇒ String^?

Parameters:

• tx (Y::Transaction)
• name (String)

Returns:

• (String, nil)

# File 'lib/y/xml.rb', line 802

#yxml_text_insert(tx, index, str) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• index (Integer)
• str (String)

# File 'lib/y/xml.rb', line 808

#yxml_text_insert_attribute(tx, name, value) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• name (String) —

  name

• value (String) —

  value

# File 'lib/y/xml.rb', line 815

#yxml_text_insert_embed(tx, index, value) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• index (Integer)
• value (String)

# File 'lib/y/xml.rb', line 830

#yxml_text_insert_embed_with_attrs(tx, index, value, attrs) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• index (Integer)
• value (true, false, Float, Integer, Array, Hash)
• attrs (Hash)

# File 'lib/y/xml.rb', line 837

#yxml_text_insert_with_attrs(tx, index, value, attrs) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• index (Integer)
• value (String)
• attrs (Hash)

# File 'lib/y/xml.rb', line 822

#yxml_text_length(tx) ⇒ Integer

Parameters:

• tx (Y::Transaction)

Returns:

• (Integer)

# File 'lib/y/xml.rb', line 845

#yxml_text_next_sibling(tx) ⇒ Y::XMLElement, ...

Parameters:

• tx (Y::Transaction)

Returns:

• (Y::XMLElement, Y::XMLText, nil)

# File 'lib/y/xml.rb', line 850

#yxml_text_observe(callback) ⇒ Integer

Returns A subscription ID.

Parameters:

• callback (Proc)

Returns:

• (Integer) —

  A subscription ID

# File 'lib/y/xml.rb', line 855

#yxml_text_parent ⇒ Y::XMLElement^?

Returns:

• (Y::XMLElement, nil)

# File 'lib/y/xml.rb', line 860

#yxml_text_prev_sibling(tx) ⇒ Y::XMLElement, ...

Parameters:

• tx (Y::Transaction)

Returns:

• (Y::XMLElement, Y::XMLText, nil)

# File 'lib/y/xml.rb', line 864

#yxml_text_push(tx, str) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• str (String)

# File 'lib/y/xml.rb', line 869

#yxml_text_remove_range(tx, index, length) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)
• index (Integer)
• length (Integer)

# File 'lib/y/xml.rb', line 875

#yxml_text_to_s(tx) ⇒ void

This method returns an undefined value.

Parameters:

• tx (Y::Transaction)

# File 'lib/y/xml.rb', line 882

#yxml_text_unobserve(subscription_id) ⇒ void

This method returns an undefined value.

Parameters:

• subscription_id (Integer)

# File 'lib/y/xml.rb', line 887