Skip to content
This repository has been archived by the owner on Dec 6, 2022. It is now read-only.

Commit

Permalink
Merge pull request #13 from ipfs/draft-file-data
Browse files Browse the repository at this point in the history
[DRAFT] File data representation.
  • Loading branch information
mikeal authored Nov 26, 2018
2 parents a2c1f3f + 4113dd6 commit 1d27441
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion SPEC.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,31 @@ The `type` field is either `file` or `dir`.
A file object has the following fields.

- `type`: String with value of `'file'`.
- `data`: TODO: Define structure for file content data.
- `data`: Array of `file-data`.
- `size`: Integer. Cumulative size of `data`.

The `type` field must be set to `file`.

### `file-data`

File data is an Array. Each element is an Array with only 2 elements (Tuple).

- 0: Array. Tuple containing two integers, the `start` and `length` offsets of the content.
- 0: Integer: start offset.
- 1: Integer: length of part(s).
- 1: Link. Either a `raw` link or a link to another node formatted as `file-data`.

```javascript
[
[ [0, 1024], Link ],
[ [1025, 1002], Link ]
]
```

Implementations are encouraged to use nested `file-data` array nodes through links for files
with many chunks in order to limit the size of the serialized node. No strict boundary is
set but it is typical to try and limit node size to less than one megabyte.

## IPLD `dir`

A directory object represents a directory.
Expand Down

0 comments on commit 1d27441

Please sign in to comment.