git/streaming.h

/*
 * Copyright (c) 2011, Google Inc.
 */
#ifndef STREAMING_H
#define STREAMING_H 1
#include "cache.h"

/* opaque */
struct git_istream;

extern struct git_istream *open_istream(const unsigned char *, enum object_type *, unsigned long *, struct stream_filter *);
extern int close_istream(struct git_istream *);
extern ssize_t read_istream(struct git_istream *, char *, size_t);

#endif /* STREAMING_H */
streaming: a new API to read from the object store Given an object name, use open_istream() to get a git_istream handle that you can read_istream() from as if you are using read(2) to read the contents of the object, and close it with close_istream() when you are done. Currently, we do not do anything fancy--it just calls read_sha1_file() and keeps the contents in memory as a whole, and carve it out as you request with read_istream(). Signed-off-by: Junio C Hamano <gitster@pobox.com> 2011-05-12 02:30:25 +00:00			`/*`
			`* Copyright (c) 2011, Google Inc.`
			`*/`
			`#ifndef STREAMING_H`
			`#define STREAMING_H 1`
			`#include "cache.h"`

			`/* opaque */`
			`struct git_istream;`

Add streaming filter API This introduces an API to plug custom filters to an input stream. The caller gets get_stream_filter("path") to obtain an appropriate filter for the path, and then uses it when opening an input stream via open_istream(). After that, the caller can read from the stream with read_istream(), and close it with close_istream(), just like an unfiltered stream. This only adds a "null" filter that is a pass-thru filter, but later changes can add LF-to-CRLF and other filters, and the callers of the streaming API do not have to change. Signed-off-by: Junio C Hamano <gitster@pobox.com> 2011-05-20 21:33:31 +00:00			`extern struct git_istream open_istream(const unsigned char , enum object_type , unsigned long , struct stream_filter *);`
streaming: a new API to read from the object store Given an object name, use open_istream() to get a git_istream handle that you can read_istream() from as if you are using read(2) to read the contents of the object, and close it with close_istream() when you are done. Currently, we do not do anything fancy--it just calls read_sha1_file() and keeps the contents in memory as a whole, and carve it out as you request with read_istream(). Signed-off-by: Junio C Hamano <gitster@pobox.com> 2011-05-12 02:30:25 +00:00			`extern int close_istream(struct git_istream *);`
			`extern ssize_t read_istream(struct git_istream , char , size_t);`

			`#endif /* STREAMING_H */`