X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fio%2Fkfile.h;h=9a750feb29a2dfe6135f8c1a4f13647de0b4db9c;hb=e8b0472be10fba4ca6baa62d8d483db90e28c06e;hp=040e04a8684495c99266103348d2995d278c2871;hpb=cd7538b224bbe4fb287b96903678df6ae435522c;p=bertos.git diff --git a/bertos/io/kfile.h b/bertos/io/kfile.h index 040e04a8..9a750feb 100644 --- a/bertos/io/kfile.h +++ b/bertos/io/kfile.h @@ -223,6 +223,12 @@ int kfile_genericClose(struct KFile *fd); /** * Read \a size bytes from file \a fd into \a buf. * + * This function reads at most the number of requested bytes into the + * provided buffer. + * The value returned may be less than the requested bytes in case EOF is + * reached OR an error occurred. You need to check the error conditions + * using kfile_error() to understand which case happened. + * * \note This function will block if there are less than \a size bytes * to read. * @@ -239,6 +245,16 @@ INLINE size_t kfile_read(struct KFile *fd, void *buf, size_t size) int kfile_gets(struct KFile *fd, char *buf, int size); int kfile_gets_echo(struct KFile *fd, char *buf, int size, bool echo); +/** + * Copy \a size bytes from file \a src to \a dst. + * + * \param src Source KFile. + * \param dst Destionation KFile. + * \param size number of bytes to copy. + * \return the number of bytes copied. + */ +kfile_off_t kfile_copy(KFile *src, KFile *dst, kfile_off_t size); + /** * Write \a size bytes from buffer \a buf into KFile \a fd. *