Header menu logo FSharp.ATProto

CarParser Module

Parser for CAR v1 (Content Addressable aRchive) files used by the AT Protocol firehose.

Functions and values

Function or value Description

parse data

Full Usage: parse data

Parameters:
    data : byte[]

Returns: Result<CarFile, string>

Parse a CAR v1 byte array into a CarFile.

data : byte[]
Returns: Result<CarFile, string>

readCborCid reader

Full Usage: readCborCid reader

Parameters:
Returns: Result<Cid, string>

Read a CID from a CBOR reader and parse it as a Cid value.

reader : CborReader
Returns: Result<Cid, string>

readCborCidString reader

Full Usage: readCborCidString reader

Parameters:
Returns: Result<string, string>

Read a CID from a CBOR reader (DAG-CBOR tag 42 link). Returns the CID string key.

reader : CborReader
Returns: Result<string, string>

readCidBytes data offset

Full Usage: readCidBytes data offset

Parameters:
    data : byte[]
    offset : int

Returns: Result<(string * int), string>

Read a CID from raw bytes at the given offset. Returns (CID string key, bytesConsumed).

data : byte[]
offset : int
Returns: Result<(string * int), string>

Type something to start searching.