WriteableStream: R6 Class representing a writeable connection

In ElianHugh/emitters: NodeJS-inspired events and io streams.

Description

R6 Class representing a writeable connection

R6 Class representing a writeable connection

Details

Events:

• drain

• error

• finish NYI

• pipe

• unpipe

Super class

emitters::EventEmitter -> WriteableStream

Methods

Public methods

• WriteableStream$new()

• WriteableStream$print()

• WriteableStream$write()

• WriteableStream$cork()

• WriteableStream$uncork()

• WriteableStream$end()

• WriteableStream$destroy()

Inherited methods

• emitters::EventEmitter$add_listener()

• emitters::EventEmitter$emit()

• emitters::EventEmitter$event_names()

• emitters::EventEmitter$get_max_listeners()

• emitters::EventEmitter$listener_count()

• emitters::EventEmitter$off()

• emitters::EventEmitter$on()

• emitters::EventEmitter$once()

• emitters::EventEmitter$prepend_listener()

• emitters::EventEmitter$prepend_once_listener()

• emitters::EventEmitter$raw_listeners()

• emitters::EventEmitter$remove_all_listeners()

• emitters::EventEmitter$remove_listener()

• emitters::EventEmitter$set_max_listeners()

---

Method new()

Create a new WriteableStream object

Usage

WriteableStream$new(
  source_object,
  highwater_mark = NULL,
  queue_strategy = object.size,
  encoding = "UTF8",
  auto_destroy = TRUE
)

Arguments

source_object

a file path, connection, processx connection, socket connection, or appendable object

highwater_mark

maximum buffer size

Returns

A new ReadableStream object. TODOC TODOC TODOC TODOC TODOC

---

Method print()

Usage

WriteableStream$print()

---

Method write()

Usage

WriteableStream$write(text, encoding = private$.writeable_encoding)

---

Method cork()

Usage

WriteableStream$cork()

---

Method uncork()

Usage

WriteableStream$uncork()

---

Method end()

Usage

WriteableStream$end()

---

Method destroy()

Usage

WriteableStream$destroy(why = NULL)

ElianHugh/emitters documentation built on Feb. 6, 2022, 4:55 a.m.