callback: Callback classes

In hipread: Read Hierarchical Fixed Width Files

Callback classes

Description

These classes are used to define callback behaviors, and are based on readr's readr::callback functions.

Details

• The callbacks HipChunkCallback, HipListCallback and HipSideEffectChunkCallback should be identical to their readr counterparts, but have been copied into hipread to ensure that they work even if readr changes.

• The callback HipDataFrameCallback is similar to readr::DataFrameCallback() except that it uses dplyr::bind_rows() instead of rbind() so that it is faster.

Methods

Public methods

• ChunkCallback$new()

• ChunkCallback$receive()

• ChunkCallback$continue()

• ChunkCallback$result()

• ChunkCallback$finally()

• ChunkCallback$clone()

---

Method new()

Usage

ChunkCallback$new(callback)

---

Method receive()

Usage

ChunkCallback$receive(data, index)

---

Method continue()

Usage

ChunkCallback$continue()

---

Method result()

Usage

ChunkCallback$result()

---

Method finally()

Usage

ChunkCallback$finally()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ChunkCallback$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super class

hipread::ChunkCallback -> HipChunkCallback

Methods

Public methods

• HipChunkCallback$clone()

Inherited methods

• hipread::ChunkCallback$continue()
• hipread::ChunkCallback$finally()
• hipread::ChunkCallback$initialize()
• hipread::ChunkCallback$receive()
• hipread::ChunkCallback$result()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HipChunkCallback$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

hipread::ChunkCallback -> hipread::HipChunkCallback -> HipSideEffectChunkCallback

Methods

Public methods

• HipSideEffectChunkCallback$new()

• HipSideEffectChunkCallback$receive()

• HipSideEffectChunkCallback$continue()

• HipSideEffectChunkCallback$clone()

Inherited methods

• hipread::ChunkCallback$finally()
• hipread::ChunkCallback$result()

---

Method new()

Usage

HipSideEffectChunkCallback$new(callback)

---

Method receive()

Usage

HipSideEffectChunkCallback$receive(data, index)

---

Method continue()

Usage

HipSideEffectChunkCallback$continue()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HipSideEffectChunkCallback$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

hipread::ChunkCallback -> hipread::HipChunkCallback -> HipListCallback

Methods

Public methods

• HipListCallback$new()

• HipListCallback$receive()

• HipListCallback$result()

• HipListCallback$finally()

• HipListCallback$clone()

Inherited methods

• hipread::ChunkCallback$continue()

---

Method new()

Usage

HipListCallback$new(callback)

---

Method receive()

Usage

HipListCallback$receive(data, index)

---

Method result()

Usage

HipListCallback$result()

---

Method finally()

Usage

HipListCallback$finally()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HipListCallback$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

hipread::ChunkCallback -> hipread::HipChunkCallback -> HipDataFrameCallback

Methods

Public methods

• HipDataFrameCallback$new()

• HipDataFrameCallback$receive()

• HipDataFrameCallback$result()

• HipDataFrameCallback$finally()

• HipDataFrameCallback$clone()

Inherited methods

• hipread::ChunkCallback$continue()

---

Method new()

Usage

HipDataFrameCallback$new(callback)

---

Method receive()

Usage

HipDataFrameCallback$receive(data, index)

---

Method result()

Usage

HipDataFrameCallback$result()

---

Method finally()

Usage

HipDataFrameCallback$finally()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HipDataFrameCallback$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

hipread documentation built on May 29, 2024, 1:50 a.m.