libgit2

git_odb_open_rstream

Version:

Open a stream to read an object from the ODB

Note that most backends do not support streaming reads because they store their objects as compressed/delta'ed blobs.

It's recommended to use git_odb_read instead, which is assured to work on all backends.

The returned stream will be of type GIT_STREAM_RDONLY and will have the following methods:

  • stream->read: read n bytes from the stream - stream->free: free the stream

The stream must always be free'd or will leak memory.

See

Signature

GitHub
int git_odb_open_rstream(git_odb_stream **out, size_t *len, git_object_t *type, git_odb *db, const git_oid *oid);

Parameters

git_odb_stream **
In
out

pointer where to store the stream

size_t *
In
len

pointer where to store the length of the object

git_object_t *
In
type

pointer where to store the type of the object

git_odb *
In
db

object database where the stream will read from

const git_oid *
In
oid

oid of the object the stream will read from

Returns

int

0 if the stream was created; error code otherwise

Versions