Godoc with example usage of carv2 primary flows #124

willscott · 2021-06-29T16:44:08Z

There should be useful documentation and examples guiding users through

an import/export roundtrip
Opening an unknown file as a blockstore
writing data to a carv2 via blockstore interface and saving it.
Top level doc todo

Implement examples that show how to open a read-only blockstore, and a read-write blockstore along with resumption from the same file. Fixes: - #124

Implement examples that show how to open a read-only blockstore, and a read-write blockstore along with resumption from the same file. The example surfaced a race condition where if the `AllKeysChan` is partially consumed and file is closed then the gorutie started by chan population causes the race condition. Locking on Close will make the closure hang. Better solution is needed but choices are limited due to `AllKeysChan` signature. Fixes: - #124

willscott · 2021-07-16T18:00:50Z

make sure also to fix the todo in top level godoc:
https://github.com/ipld/go-car/blob/master/v2/doc.go#L2

mvdan · 2021-07-16T18:05:40Z

Yep! I actually noticed this just minutes before you wrote this comment, too, as I was looking at the pkgsite links I shared :)

Implement examples that show how to open a read-only blockstore, and a read-write blockstore along with resumption from the same file. The example surfaced a race condition where if the `AllKeysChan` is partially consumed and file is closed then the gorutie started by chan population causes the race condition. Locking on Close will make the closure hang. Better solution is needed but choices are limited due to `AllKeysChan` signature. Fixes: - ipld/go-car#124 This commit was moved from ipld/go-car@ae4ddd4

willscott added this to the CAR v2 milestone Jun 29, 2021

masih added a commit that referenced this issue Jul 16, 2021

Add example blockstore examples

9fb39cc

Implement examples that show how to open a read-only blockstore, and a read-write blockstore along with resumption from the same file. Fixes: - #124

masih mentioned this issue Jul 16, 2021

Add example blockstore examples #180

Merged

masih added a commit that referenced this issue Jul 16, 2021

Add example blockstore examples

1798caf

Implement examples that show how to open a read-only blockstore, and a read-write blockstore along with resumption from the same file. Fixes: - #124

masih added a commit that referenced this issue Jul 16, 2021

Add example blockstore examples

d9aa434

Implement examples that show how to open a read-only blockstore, and a read-write blockstore along with resumption from the same file. Fixes: - #124

masih added a commit that referenced this issue Jul 16, 2021

Add example blockstore examples

a4cebbe

Implement examples that show how to open a read-only blockstore, and a read-write blockstore along with resumption from the same file. Fixes: - #124

masih closed this as completed in 61cfb4d Aug 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Godoc with example usage of carv2 primary flows #124

Godoc with example usage of carv2 primary flows #124

willscott commented Jun 29, 2021 •

edited by masih

willscott commented Jul 16, 2021

mvdan commented Jul 16, 2021

Godoc with example usage of carv2 primary flows #124

Godoc with example usage of carv2 primary flows #124

Comments

willscott commented Jun 29, 2021 • edited by masih

willscott commented Jul 16, 2021

mvdan commented Jul 16, 2021

willscott commented Jun 29, 2021 •

edited by masih