| Title: | R Bindings to the 'Rust' 'IPLD' Library |
| Version: | 0.1.1 |
| Description: | Provides R bindings to decode DAG-CBOR (Directed Acyclic Graph Concise Binary Object Representation) encoded data, CIDs (Content Identifiers), and CAR (Content Addressable aRchive) files using the 'Rust' 'IPLD' (InterPlanetary Linked Data) library https://github.com/ipld/libipld. This is especially useful for working with data from 'IPFS' (InterPlanetary File System) and 'AtProto' (Bluesky) applications. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/JBGruber/libipldr |
| BugReports: | https://github.com/JBGruber/libipldr/issues |
| Encoding: | UTF-8 |
| Config/rextendr/version: | 0.4.2 |
| SystemRequirements: | Cargo (Rust's package manager), rustc >= 1.65 |
| Suggests: | testthat (≥ 3.0.0), rextendr (≥ 0.2.0), httr2, jsonlite, spelling |
| Config/testthat/edition: | 3 |
| Depends: | R (≥ 4.2) |
| Config/roxygen2/version: | 8.0.0 |
| Language: | en-US |
| NeedsCompilation: | yes |
| Packaged: | 2026-05-20 11:44:19 UTC; johannes |
| Author: | Johannes B. Gruber
 [aut, cre],
Ilya Siamionau [ctb] (Author of the original python-libipld Rust
implementation) |
| Maintainer: | Johannes B. Gruber <JohannesB.Gruber@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2026-05-27 19:40:02 UTC |
libipldr: R Bindings to the 'Rust' 'IPLD' Library
Description
Provides R bindings to decode DAG-CBOR (Directed Acyclic Graph Concise Binary Object Representation) encoded data, CIDs (Content Identifiers), and CAR (Content Addressable aRchive) files using the 'Rust' 'IPLD' (InterPlanetary Linked Data) library https://github.com/ipld/libipld. This is especially useful for working with data from 'IPFS' (InterPlanetary File System) and 'AtProto' (Bluesky) applications.
Author(s)
Maintainer: Johannes B. Gruber JohannesB.Gruber@gmail.com (ORCID)
Authors:
Johannes B. Gruber JohannesB.Gruber@gmail.com (ORCID)
Other contributors:
Ilya Siamionau (Author of the original python-libipld Rust implementation) [contributor]
See Also
Useful links:
Decode a Content Addressable aRchive (CAR) file
Description
This function decodes a CAR file from a raw vector, extracting the header and blocks.
Usage
decode_car(data)
Arguments
data |
A raw vector containing a CAR file |
Value
A list with header information and decoded blocks
Examples
car_file <- system.file("extdata", "sample.car", package = "libipldr")
car_data <- readBin(car_file, what = "raw", n = file.size(car_file))
decode_car(car_data)
Decode a Content IDentifier (CID) string
Description
This function decodes a CID string into its components (version, codec, and hash).
Usage
decode_cid(cid_str)
Arguments
cid_str |
A string containing a valid CID |
Value
A list with CID components
Examples
# Decode a CID:
cid_info <- decode_cid("bafyreib775pirw4o3rz4iwdjwi3rz7q4z5t4xjyfrwnk2yukhzo2wyr4ye")
Decode DAG-CBOR encoded data to an R object
Description
This function decodes a raw vector containing DAG-CBOR encoded data into an R object. DAG-CBOR is a deterministic subset of the CBOR format, used by IPFS and AtProto (Bluesky) for data representation.
Usage
decode_dag_cbor(data)
Arguments
data |
A raw vector containing DAG-CBOR encoded data |
Value
An R object representing the decoded data
Examples
# Decode a simple DAG-CBOR map {"a": "Hello", "b": "World!"}
cbor_data <- as.raw(c(
0xa2, 0x61, 0x61, 0x65, 0x48, 0x65, 0x6c, 0x6c, 0x6f,
0x61, 0x62, 0x66, 0x57, 0x6f, 0x72, 0x6c, 0x64, 0x21
))
decode_dag_cbor(cbor_data)
Decode multiple DAG-CBOR objects from a byte stream
Description
This function decodes multiple consecutive DAG-CBOR objects from a single raw vector. The returned list includes a 'bytes_consumed' attribute indicating how many bytes from the beginning of the input were successfully processed. This is useful for streaming applications where you need to know where to continue reading.
Usage
decode_dag_cbor_multi(data)
Arguments
data |
A raw vector containing multiple DAG-CBOR encoded objects |
Value
A list of R objects, each representing a decoded DAG-CBOR object
Examples
# Decode two consecutive DAG-CBOR objects from a single byte stream
cbor_data <- as.raw(c(
0xa2, 0x61, 0x61, 0x65, 0x48, 0x65, 0x6c, 0x6c, 0x6f,
0x61, 0x62, 0x66, 0x57, 0x6f, 0x72, 0x6c, 0x64, 0x21,
0xa1, 0x61, 0x63, 0x01
))
results <- decode_dag_cbor_multi(cbor_data)
attr(results, "bytes_consumed")