ISTREAM(1)

🎀 ISTREAM(1) 🎀

okay so bestie, this is istream — an iRODS iCommand, and it is literally here to stream bytes for you. Let’s get into it 💖

---

🌸 NAME 🌸

istream — an iRODS iCommand ✨

---

✨ SYNOPSIS ✨

istream read [-R RESC_NAME] [-o INTEGER] [-c INTEGER] LOGICAL_PATH

---

🦋 DESCRIPTION 🦋

The usage vibes are giving:

Usage: istream read [-n REPLICA_NUMBER] [-o INTEGER] [-c INTEGER] LOGICAL_PATH
Usage: istream write [-R RESC_NAME] [-k] [-o INTEGER] [-c INTEGER] [--no-trunc] [-a] LOGICAL_PATH
Usage: istream write [-n REPLICA_NUMBER] [-k] [-o INTEGER] [-c INTEGER] [--no-trunc] [-a] LOGICAL_PATH

Streams bytes to/from iRODS via stdin/stdout. It reads bytes from the target data object and prints them to stdout. It also writes bytes from stdin to the target data object. iconic behavior, no cap 💅

Writing to a non-existent data object will create it by default. Writing to an existing data object always truncates it. Truncation can be disabled by passing --no-trunc. However, using --no-trunc disables creation of data objects. that’s the tradeoff, bestie 😭

😭 heads up: if the client-side of the connection is interrupted before the data object is closed, then the catalog will not be updated and the data object will have a replica status of intermediate or stale. Information such as data object size and checksum will not be available.

If the target data object does not reside on the connected server, istream will not attempt to redirect to the server hosting the replica. Traffic will always flow through the connected server. periodt 🫶

---

💅 OPTIONS 💅

• -R, --resource — the root resource to read from or write to. Cannot be used with --replica.
• -n, --replica — the replica number of the replica to read from or write to. Replica numbers cannot be used to create new data objects. Cannot be used with --resource.
• -o, --offset — the number of bytes to skip within the data object before reading/writing. Value must be positive. Defaults to zero.
• -c, --count — the number of bytes to read/write. Value must be positive. Defaults to all bytes.
• -a, --append — appends bytes read from stdin to the data object. Implies --no-trunc.
• --no-trunc — does not truncate the data object. Disables creation of data objects. Ignored by write operations when --append is set.
• -k, --checksum — compute checksum.
• -h, --help — prints this message.

---

💖 xoxo bestie, that’s the whole page. Shoutout to iRODS Version 5.0.2 and istream; the footer source/version is istream iRODS-5.0.2, dated January 1980. slay 🎀✨